Visitar URL original
docs: generalize repo conventions and expand CONTRIBUTING.md by swikstrom · Pull Request #3054 · arduino/docs-content · GitHub
Skip to content

docs: generalize repo conventions and expand CONTRIBUTING.md - #3054

Open
swikstrom wants to merge 1 commit into
mainfrom
improve-repo-docs
Open

swikstrom wants to merge 1 commit into
mainfrom
improve-repo-docs

Conversation

@swikstrom

Copy link
Copy Markdown
Contributor

What This PR Changes

This PR restructures the repository's authoring documentation to serve as a comprehensive, structured reference.

  • Expanded CONTRIBUTING.md: Created a full reference guide covering repository organization, routing, frontmatter schemas, writing style, MDX formatting (including explicit <Alert> parsing rules), and linter boundaries.
  • Streamlined README.md: Removed duplicate contribution instructions.

Contribution Guidelines

Comment thread README.md
## License

![](https://i.creativecommons.org/l/by-sa/3.0/88x31.png)
Please note that your contribution to the Arduino Documentation is licensed under a [Creative Commons Attribution-Share Alike 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think this sentence should be about the content inside the entire repository, not focusing on contributions only.

@swikstrom swikstrom Sep 17, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

How about this?

Suggested change
Please note that your contribution to the Arduino Documentation is licensed under a [Creative Commons Attribution-Share Alike 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
Please note that your contribution are licensed under a [Creative Commons Attribution-Share Alike 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).

In the context of a GitHub repository, any commit is a "contribution". So if we remove the "Arduino Documentation" qualifier, it should be clear.

Alternatively, we can remove this part and let LICENSE.md be the source of truth. That file is also available in the repo sidebar:

Screenshot 2026-09-17 at 14 39 22

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

either way for me is fine. We could just link to the license file at the end then maybe? Without a description?

@jhansson-ard jhansson-ard added arduino Bugs and fixes added by the Arduino Team infrastructure Fixes and updates to the infrastructure of the repo labels Sep 18, 2026

This branch has not been deployed

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

Labels

arduino Bugs and fixes added by the Arduino Team infrastructure Fixes and updates to the infrastructure of the repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants