libretro / libretro/docs

Improve "Contribute to the documentation" with web/github workflow

Open
#297 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TeX
Stars
346
Forks
860
Avg merge
5d 16h
Merged PRs (30d)
7

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:

  1. previously unfamiliar with git and the github workflow
  2. 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.