Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish documentation catalogs #1105

Merged
merged 49 commits into from
Jan 6, 2025
Merged

Polish documentation catalogs #1105

merged 49 commits into from
Jan 6, 2025

Conversation

defagos
Copy link
Member

@defagos defagos commented Jan 1, 2025

Description

This PR polishes documentation catalogs to have a more consistent documentation.

Changes made

  • Use LLMs to rephrase content. This makes style and English more consistent. Additional proofreading was performed afterwards to ensure nothing is lost and that ideas conveyed are correct.
  • Make some tutorials simpler (reduce number of steps, tighten code).
  • Fix non-playing RTS VOD example.
  • Fix incorrect links to SRG SSR internal wiki.
  • Improve Player documentation sections (same as Apple documentation style).
  • Make documentation clearer where appropriate.
  • Replace generated header images with real ones.

Conventions

Here are some of the conventions applied. Those match the style of Apple documentation closely (e.g. SwiftUI documentation):

  • Article titles start with gerund, sections start with verb.
  • Articles titles use title case.
  • Article section titles are only capitalized.
  • Bullet points items with item name in bold / title case.
  • "For example" uses US English style (e.g., a, b, c).
  • Improve existing extensions. For some reason this also fixes documentation warnings appeared with Xcode 16.

Checklist

  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).

@defagos defagos enabled auto-merge January 1, 2025 21:53
@defagos defagos self-assigned this Jan 1, 2025
@defagos defagos changed the title Polish documentation packages Polish documentation catalogs Jan 1, 2025
defagos and others added 2 commits January 6, 2025 11:13
Co-authored-by: Walid Kayhal <[email protected]>
Co-authored-by: Walid Kayhal <[email protected]>
@defagos defagos added this pull request to the merge queue Jan 6, 2025
Merged via the queue into main with commit 43bd3e5 Jan 6, 2025
7 checks passed
@defagos defagos deleted the documentation-polishing branch January 6, 2025 21:59
@defagos defagos mentioned this pull request Jan 14, 2025
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants