getodk / getodk/docs

how to edit on github

Open
#825 2 comments 1 reaction 0 assignees View on GitHub
help wanted
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

We have an Edit on Github link, but if you aren't sure how to use it, it probably doesn't help that much.

So we need:

- clear instructions on the process (probably a small document linked from docs-tech)
- clear guidelines about what sorts of edits are reasonable to do without a local setup

Contributor guide

Open the contributing guide

Research direction

Start by inspecting the current Edit on Github link and the docs-tech documentation area. Add a short explanation of the editing process and guidelines for edits that can be made without a local setup; the work is done when both topics are clearly documented and linked from the relevant documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.