Skip to content

docs: add missing files to "List of Documents" in contributor docs#4000

Open
Khushi256 wants to merge 2 commits intoprocessing:developfrom
Khushi256:docs/add-missing-contributor-docs
Open

docs: add missing files to "List of Documents" in contributor docs#4000
Khushi256 wants to merge 2 commits intoprocessing:developfrom
Khushi256:docs/add-missing-contributor-docs

Conversation

@Khushi256
Copy link

Issue:

Fixes #3977

The "List of Documents" section in contributor_docs/README.md did not include several documentation files that currently exist in the contributor_docs directory. This could make it harder for contributors to discover all available documentation resources.

This PR updates the list to include the missing files and ensures the index accurately reflects the contents of the directory.

Demo:

N/A (Documentation-only change)

Changes:

  • Added missing documentation files to the "List of Documents" section in contributor_docs/README.md.
  • Ensured each document is linked properly for easier navigation.
  • Improved discoverability of contributor documentation.

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • has no typecheck errors (npm run typecheck)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123
  • meets the standards outlined in the accessibility guidelines

Copy link
Contributor

@yugalkaushik yugalkaushik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked all the links and descriptions and they LGTM.

@raclim
Copy link
Collaborator

raclim commented Mar 17, 2026

Thanks @Khushi256 and @yugalkaushik, I agree that this looks overall good to me! @Jatin24062005, please feel free to check this out as well!

@Jatin24062005

This comment was marked as resolved.

@Khushi256
Copy link
Author

Hi @Jatin24062005 ! Thanks for the suggestion , I checked the contributor_docs/README.md and all three files are actually already linked in the "List of Documents" section:

  • preparing_an_issue.md -> Instructions for creating and navigating issues. (line - 13)
  • public_api_proposed.md -> Proposed API extensions and design notes for future endpoints. (line - 21)
  • GSOC_hinter_and_refactoring_changes.md -> Architecture overview for autocomplete hinter and refactoring systems built during GSoC 2025. (line - 24)

Let me know if I missed anything or if there's something else that needs to be added!

@Jatin24062005
Copy link
Contributor

Thanks @Khushi256 for checking and clarifying — that was my oversight, I missed that these were already linked in contributor_docs/README.md.

For consistency, I’d suggest updating:

  • ./testingtesting.md
  • ./release.mdrelease.md

This will keep the file references uniform across the docs.

Apart from that, @raclim everything looks good 👍

@Khushi256
Copy link
Author

Hi @Jatin24062005 ! I've addressed the feedback - updated ./testing.md and ./release.md to testing.md and release.md to keep the file references consistent across the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing files in "List of Documents" section in contributor docs

4 participants