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

[📑 Docs]: Reorganize documents in the community repo #1650

Open
1 task done
Tracked by #1622
bandantonio opened this issue Jan 18, 2025 · 0 comments
Open
1 task done
Tracked by #1622

[📑 Docs]: Reorganize documents in the community repo #1650

bandantonio opened this issue Jan 18, 2025 · 0 comments

Comments

@bandantonio
Copy link
Contributor

What Dev Docs changes are you proposing?

Based on the initial discussion in #1638 (comment)

According to the selected documentation projects for the Mentorship Program 2024, mentees will be working on adding new and expanding the existing guides. To keep the existing guides untouched and preserve original context and cross-linking, mentees will create updated versions of the guides that will eventually be merged with the "original ones".
For example, the original guide on how to (Become Maintainer in Existing Project and the updated one submitted in #1638. that

It would be beneficial to reorganize all the existing documents within the community project along with the guides that are going to be created because this will simplify accessibility, discoverability, and navigation. For now, in some cases, at least I am having hard times finding the proper guide even when I know that it must be somewhere near.

Possible implementation:

  • Brainstorm possible reorganization variants
  • Create a page or section with a clear navigation that would act as a single entry point for all the contribution-related documents within the repo.
  • Ensure the info in the documents is still relevant
  • Update cross-linking

Code of Conduct

  • I agree to follow this project's Code of Conduct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant