Improve "Contribute to the documentation" with web/github workflow
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github
- Domain
- documentation
Research direction
Start with the linked “Contribute to the documentation” guide in the meta section and review the existing mkdocs build information. Define the GitHub web-editor workflow for contributors who cannot use a console, including the proposed screenshots, and consider the work done when the guide explains that process end to end.
Written by the indexing model from the issue text.
Description
As a part of my recent work, I have tried to make improvements to the "meta" section of the docs as it has come up in other projects.
For example I consolidated and added to the mkdocs build information.
That being said, I have been in contact with @Clutz450 -- someone who is qualified and prepared to make contributions to the docs for the first time but who is:
- previously unfamiliar with git and the github workflow
- not able to work with the msys2/console environment due to network restrictions
I think it would be good to further develop the "Contribute to the documentation guide in terms of the workflow for contributing to the docs purely from within the github web editor.
Because the private conversation I have been having with @Clutz450 is starting to generate useful ideas for the docs I'm hoping to move it here to the github repo where other conversations are happening.
Maybe we could have a new section focused on contributing via github that has some screenshots of the process?
@thatman84 I'm tagging you since we've been chatting about the direction the docs are going
- Dominant language
- TeX
- Stars
- 346
- Forks
- 860
- Avg merge
- 5d 16h
- Merged PRs (30d)
- 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from libretro/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
bug
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
certification
Difficulty 1/5 Under an hour Newbie friendliness 80/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
bisq-network/support#2181 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
tutorial updates Open
Difficulty 1/5 Under an hour Newbie friendliness 80/100
sveltejs/svelte.dev#2241 ·