Skip to content

Add guide for editing documentation on GitHub - #438

Merged
TanbirRamim merged 2 commits into
TanbirRamim:mainfrom
angusakthis-cpu:add-beginner-friendly-pr-guide
Nov 7, 2026
Merged

TanbirRamim merged 2 commits into
TanbirRamim:mainfrom
angusakthis-cpu:add-beginner-friendly-pr-guide

Conversation

@angusakthis-cpu

Copy link
Copy Markdown
Contributor

Added a beginner-friendly guide explaining how to edit documentation using the GitHub website.

What does this change, and why?

This guide helps beginners understand how to make documentation changes directly through the GitHub website. It provides simple instructions to make the open-source contribution process easier for first-time contributors.

Changes made

  • Added a beginner-friendly documentation editing guide.
  • Explained the steps for making documentation changes using GitHub.
  • Helped new contributors understand the contribution workflow.

Checklist

  • Added documentation guide.
  • Changes committed to a separate branch.
  • No unrelated files modified.

Added instructions for making documentation changes using the GitHub website.
@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown
Contributor

Thanks for the pull request, @angusakthis-cpu. Before a maintainer reviews it, one thing needs a look:

PR template was removed [please check]

The description doesn't follow this repo's pull request template.

Please edit the description and paste the template back in, then fill it out. You can find it in the repo under .github/.

Passed: recent pull requests, account history, diff scope.

This comment is from pr-doorman, a set of plain rules the maintainers turned on. It doesn't use AI. It updates itself when you edit or push to the pull request.

@TanbirRamim
TanbirRamim merged commit 6097091 into TanbirRamim:main Nov 7, 2026
9 checks passed
@TanbirRamim

Copy link
Copy Markdown
Owner

Thanks @angusakthis-cpu, nice addition. I moved it up above the checklist (it was sitting after the Next link) and adjusted the steps a bit so they match what GitHub shows now. Merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants