Refactor docs-contributors to use tables and fix punctuation#8260
Refactor docs-contributors to use tables and fix punctuation#8260Hesara2003 wants to merge 1 commit intoreactjs:mainfrom
Conversation
|
Hi @Hesara2003! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
Size changesDetails📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
|
This looks significantly worse, we'll make updates to the page as needed. |
Summary
This PR significantly refactors the layout of the docs-contributors.md page to enhance visual clarity and consistency. It moves away from simple bulleted lists to structured Markdown tables, allowing for a clearer separation between contributors and their specific contributions. Additionally, it addresses minor punctuation inconsistencies found in the community documentation to align with standard grammar usage.
Detailed Changes
1. Structural Improvements to docs-contributors.md
The main focus of this PR is transforming the "Content", "Design", and "Development" sections.
* [Name](link): role), which could become cluttered and hard to scan, especially for entries with multiple contributors or long role descriptions.2. Punctuation & Grammar Fixes
[link.]), and has been moved outside (e.g.,[link].) to follow standard Markdown and grammatical conventions.Motivation
As the community documentation grows, maintaining a clean and structured layout is essential. The switch to tables provides a scalable way to present contributor information that is visually distinct from standard text content. Standardizing punctuation ensures a polished and consistent reading experience across the documentation site.