[Docs] Add Contribution Guidelines and Automate Doc Updates#51
Merged
Conversation
This commit introduces a `contributing.md` file to provide clear guidelines for new contributors and integrates it into the project's documentation site. Key changes include: * **New `contributing.md`:** Added a document that outlines how to report issues, request features, and submit pull requests. It also links to the Code of Conduct. * **Documentation Update:** The `mkdocs.yml` configuration has been updated to include a "Contributing" section in the site's main navigation, making the new guidelines easily accessible.
This commit introduces contribution guidelines and a code of conduct to the project. It also refactors the documentation build process to keep the published documents in sync with the root files.
Key changes include:
* **Contribution Documents:** Added `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` to the project root, establishing clear guidelines for contributors.
* **Documentation Automation:**
* Enabled the `include-markdown` plugin in `mkdocs.yml`.
* Updated the documentation pages (`docs/contributing.md` and `docs/code_of_conduct.md`) to embed content directly from the root files, ensuring a single source of truth.
* **CI/CD Update:** Added the `mkdocs-include-markdown-plugin` to the `release-publish.yml` GitHub Actions workflow to support the new documentation build process.
jacksever
changed the title
…cumentation to GitHub Pages
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces a
contributing.mdfile to provide clear guidelines for new contributors and integrates it into the project's documentation site.Key changes include:
contributing.md: Added a document that outlines how to report issues, request features, and submit pull requests. It also links to the Code of Conduct.mkdocs.ymlconfiguration has been updated to include a "Contributing" section in the site's main navigation, making the new guidelines easily accessible.