Skip to content

Commit 5f9982d

Browse files
authored
docs: documentation readme and contribution guide update (#10023)
* draft readme and contrib-guide upd * info on versioning * python scripts remove explainer * additional updates * vale instructions upd * table of contents * language * cleanup redundancies * Update package.json * section on llms.txt support * improvements from pr review
1 parent d08b54b commit 5f9982d

4 files changed

Lines changed: 563 additions & 232 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ and smooth out the experience for all involved. The community looks forward to y
2525
- [Suggesting Enhancements](#suggesting-enhancements)
2626
- [Before Submitting an Enhancement](#before-submitting-an-enhancement)
2727
- [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
28+
- [Contributing to Documentation](#contributing-to-documentation)
2829
- [Contribute code](#contribute-code)
2930
- [Where to start](#where-to-start)
3031
- [Setting up your development environment](#setting-up-your-development-environment)
@@ -129,6 +130,10 @@ Enhancement suggestions are tracked as GitHub issues of type [Feature request fo
129130
- Use a **clear and descriptive title** for the issue to identify the suggestion.
130131
- Fill the issue following the template
131132

133+
## Contributing to Documentation
134+
135+
If you'd like to improve the documentation by fixing errors, clarifying explanations, adding examples, or creating new guides, see the [Documentation Contributing Guide](docs-website/CONTRIBUTING.md).
136+
132137
## Contribute code
133138

134139
> [!IMPORTANT]

0 commit comments

Comments
 (0)