Add contribution guidelines and improve README structure#219
Conversation
…beginner-friendliness
|
The Behavior Graphs doc has been fully refactored for clarity and beginner-friendliness. All prior content is preserved and better organized. Let me know if you'd like any final tweaks! |
|
Thank you for the pull request. Tagging @hobbs-Hobbler for review as well. |
| ## 📄 Adding New Docs | ||
| To add new documentation: | ||
|
|
||
| 1. Create a new .md file in the docs/ folder. |
There was a problem hiding this comment.
we need to mention the Docusaurus header and what's in it, which is not MarkDown
There was a problem hiding this comment.
✅ README is now updated with in-context links to:
- Pull Request Guidelines
- Commit Message Guidelines
- Markdown syntax help
All feedback has been addressed, and unrelated file changes have been removed. Thank you!
@Exairnous @DougReeder
|
@HussainAther Thank you for your work on this. As discussed at the Hubs Documentation Session last week, the text for |
HussainAther
force-pushed
the
docs-contribution-guidelines
branch
from
53c5c6d to
acf4bad
Compare
…re removed are fixed
Why: npm install will install the latest version of all the libraries, which could introduce extraneous changes to pull requests or cause the behaviour exhibited by the docs to be different between contributors. Using npm ci will ensure everyone is all on the same version of all the libraries.
3 participants
What?
This PR adds a beginner-friendly set of contribution guidelines to the Hubs Docs repository. It also refactors the README to improve structure, clarity, and navigation for new contributors.
Why?
Based on feedback from PR #201, this PR splits out the contribution and formatting work into its own focused submission. It aims to help new contributors quickly understand how to get started and how to contribute effectively to the documentation.
How to test
Review the new CONTRIBUTING.md and README.md files to ensure the instructions are clear, complete, and consistent with project goals.
Additional Context
This complements the beginner introduction to Behavior Graphs in PR #201 and helps build a foundation for ongoing documentation structure improvements.