docs: add missing files to "List of Documents" in contributor docs#4000
docs: add missing files to "List of Documents" in contributor docs#4000Khushi256 wants to merge 2 commits intoprocessing:developfrom
Conversation
yugalkaushik
left a comment
There was a problem hiding this comment.
Checked all the links and descriptions and they LGTM.
|
Thanks @Khushi256 and @yugalkaushik, I agree that this looks overall good to me! @Jatin24062005, please feel free to check this out as well! |
This comment was marked as resolved.
This comment was marked as resolved.
|
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:
Let me know if I missed anything or if there's something else that needs to be added! |
|
Thanks @Khushi256 for checking and clarifying — that was my oversight, I missed that these were already linked in For consistency, I’d suggest updating:
This will keep the file references uniform across the docs. Apart from that, @raclim everything looks good 👍 |
|
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. |
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:
I have verified that this pull request:
npm run lint)npm run test)npm run typecheck)developbranch.Fixes #123