Skip to content

Docs: Creating a contribution guide for Foundry#215

Open
rclune wants to merge 1 commit intoproductionfrom
docs-rac-contributors-guide
Open

Docs: Creating a contribution guide for Foundry#215
rclune wants to merge 1 commit intoproductionfrom
docs-rac-contributors-guide

Conversation

@rclune
Copy link
Member

@rclune rclune commented Feb 16, 2026

I created a contribution guide for foundry that is meant to live both in the main directory and in the external documentation. Since this file lives outside of the docs folder but I still wanted it in the external documentation, the contributing_link.rst file is necessary. The content in the guide is based on the Atomworks contribution guide and some of the information provided in the Foundry README. Since this is mean to be rendered both on GitHub and Sphinx, I had to suppress Sphinx's xref_missing warnings because while these references are hidden in the Sphinx-built docs, they are visible in the GitHub rendered docs.

While creating this file I realized that a docs_requirements.txt file needed to be created so that contributors could easily make the necessary docs environment to run Sphinx.

I created a contribution guide for foundry that is meant to live both in the main directory and in the external documentation. Since this file lives outside of the `docs` folder but I still wanted it in the external documentation, the `contributing_link.rst` file is necessary.  The content in the guide is based on the Atomworks contribution guide and some of the information provided in the Foundry README. Since this is mean to be rendered both on GitHub and Sphinx, I had to suppress Sphinx's `xref_missing` warnings because while these references are hidden in the Sphinx-built docs, they are visible in the GitHub rendered docs.

While creating this file I realized that a docs_requirements.txt file needed to be created so that contributors could easily make the necessary docs environment to run Sphinx.
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.

1 participant