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

Cleanup of docs/design directory #6256

Open
loicraux opened this issue Feb 20, 2024 · 0 comments
Open

Cleanup of docs/design directory #6256

loicraux opened this issue Feb 20, 2024 · 0 comments
Assignees
Labels
priority: P3 Useful but not urgent type: docs Improvements or fixes to documentation type: enhancement New feature or request
Milestone

Comments

@loicraux
Copy link
Contributor

Have you read the FAQ and checked for duplicate open issues?
Yes

Is your feature request related to a problem? Please describe.
Understanding the design of Shaka Player in order to be able to contribute with PRs that meet quality & design requirements can be difficult for newcomers. I see that there are design documents under docs/design folder but these documents are between 2 and 7 years old, so I'm not sure if they're up to date when I read them...

Describe the solution you'd like
It would be great if the design documents under docs/design were arranged in different sub-folders. I propose the following sub-folders for instance :

  • docs/design/ongoing_work for design proposals related to ongoing work (for a future next major release ?). Content is meant to be moved to docs/design/current once related design has been shipped, or deleted is feature/design has indeed been dropped.
  • docs/design/current for design docs up-to-date with the current design of Shaka Player
  • docs/design/outdated for legacy documents that are not up to date with the current Shaka Player design, but which are considered to remain worthy of interest.

Describe alternatives you've considered
I couldn't think of any other way to clean up the docs/design folder, but any solution that makes it easier to familiarize yourself with the current Shaka Player design thanks to the existing documentation is welcome.

Additional context
#1301 (comment)

@loicraux loicraux added the type: enhancement New feature or request label Feb 20, 2024
@shaka-bot shaka-bot added this to the Backlog milestone Feb 20, 2024
@avelad avelad added the type: docs Improvements or fixes to documentation label Feb 24, 2024
@joeyparrish joeyparrish added the priority: P3 Useful but not urgent label Mar 12, 2024
@joeyparrish joeyparrish self-assigned this Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: P3 Useful but not urgent type: docs Improvements or fixes to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants