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.

Sign up for GitHub

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

Jump to bottom

WIP: Improve documentation on how to contribute to documentation #183

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

WIP: Improve documentation on how to contribute to documentation #183

wants to merge 6 commits into from

Commits on Sep 5, 2024

  1. Add suggestion to improve documentation

    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    280e10b View commit details
    Browse the repository at this point in the history

  2. Add link to contributing to this guide

    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    2526e4b View commit details
    Browse the repository at this point in the history

  3. Make Code of Conduct note more prominent

    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    4d97267 View commit details
    Browse the repository at this point in the history

  4. Explain what markup means

    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    f0c03ec View commit details
    Browse the repository at this point in the history

  5. Change order of sections to group different kinds of docs 

    Trying to put the introductory sections higher up and splitting later material into: code docs, tutorials, this guide.
    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    26a9787 View commit details
    Browse the repository at this point in the history

  6. Remove extra space and avoid jargon

    @SJaffa
    SJaffa authored Sep 5, 2024
    Configuration menu
    Copy the full SHA
    5c1e644 View commit details
    Browse the repository at this point in the history