Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs ]: documentation for first time contributors #3258

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

that-ar-guy
Copy link
Contributor

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

  • PR has a meaningful title
  • Summarized changes
  • Change is not breaking
  • This PR is ready to merge and is not Work in Progress
  • Rule changes
    • Unit tests created/ updated
    • Rule documentation created/ updated
    • Link to a filed issue
    • Change log has been updated with change under unreleased section
  • Other code changes
    • Unit tests created/ updated
    • Link to a filed issue
    • Change log has been updated with change under unreleased section

@that-ar-guy that-ar-guy requested a review from a team as a code owner February 18, 2025 16:49
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.

Add dedicated documentation for updates to documentation only
1 participant