Skip to content

docs: tweaks to doc contribution guide #6105

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

Open
medubelko wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −9
Open

docs: tweaks to doc contribution guide #6105

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f133a5
docs: compress intro of doc contribution guide
medubelko Mar 16, 2026
fc6d5c0
docs: add RTD preview to doc contribution guide
medubelko Mar 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions docs/contribute/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,9 @@ Contribute to this documentation

This guide describes how to make a change to the documentation in Snapcraft.

Changing the documentation involves:

- Running commands in a command-line interface or terminal
- Writing in reStructuredText
- Saving changes in Git
- Syncing changes with a personal GitHub account

If you're unfamiliar with any of these activities, we recommend you first build some
experience in :ref:`contribute-coda`.
Documenting involves running commands in a command-line interface and syncing code with
Git and GitHub. If you're new to these tools, we recommend you make your first
contribution to Snapcraft with the help of :ref:`contribute-coda`.
Copy link
Contributor Author

@medubelko medubelko Mar 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jahn-junior How do you feel about "with the help of"?



Set up your work environment
Expand Down Expand Up @@ -237,6 +231,9 @@ Address quality concerns
Before the PR is merged, it must pass all automatic checks, and it needs separate
approvals from two maintainers.

Each PR builds a preview of the documentation on Read the Docs. For safety, it's a good
idea to manually verify that the preview looks identical to your local build.

If there are any issues in your branch that your local testing didn't catch, then the
automatic checks will fail. To address these issues, review the logs in the failed
checks. The error messages in the logs will have remedies and hints for what needs
Expand Down
Loading