[docs ]: documentation for first time contributors #3258
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.
closes : #3099
PR Summary
This pull request introduces a new guide for contributing to documentation and updates the navigation structure to include this guide. The most important changes include the addition of a comprehensive "Getting Started with Documentation" guide and the corresponding update to the
mkdocs.yml
file.Documentation improvements:
docs/license-contributing/getting-started-with-documentation.md
: Added a new guide to help contributors understand how to update and improve the documentation, including general documentation and rule-specific documentation. This guide covers prerequisites, locating documentation files, updating documentation, and best practices for writing documentation.Navigation structure update:
mkdocs.yml
: Updated the navigation structure to include the new "Getting Started with Documentation" guide under the "License and contributing" section.PR Checklist