Skip to content

Add guide for editing documentation on GitHub #438

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

Merged
TanbirRamim merged 2 commits into from
Nov 7, 2026
Merged

Add guide for editing documentation on GitHub #438

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b311feb
Add guide for editing documentation on GitHub
angusakthis-cpu Nov 7, 2026
96f6b49
Move the web-editor steps above the checklist and match GitHub's curr…
TanbirRamim Nov 7, 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
11 changes: 11 additions & 0 deletions guide/05-first-pull-request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,17 @@ git push --force-with-lease

`--force-with-lease` is the safe way to update a branch you rewrote; it refuses to overwrite commits you do not have locally. Some projects prefer merging `upstream/main` into your branch instead of rebasing; follow their guide.

## Small doc fixes without Git

For a typo or a broken link you can skip the clone entirely and do it in the browser:

1. Open the file on GitHub in the original repository and click the pencil icon. If you can't push there, GitHub forks the repository for you.
2. Make the change and check the Preview tab.
3. Click "Commit changes...", choose "Create a new branch", and give it a short name like `fix-readme-typo`.
4. Click "Propose changes", then "Create pull request" and fill in the template.

This only suits small text changes. Anything that needs a build or tests should go through the steps above, so you can run the checks before you push.

## Checklist

- [ ] Branch created from the latest upstream default branch.
Expand Down
Loading