keybase / keybase/keybase-issues
Publish documentation source
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 899
- Forks
- 40
- PR merge metrics
- No merged PRs in 30d
Description
The API documentation is somewhat outdated and is not being updated (probably due to the lack of time). Why don’t you create a repository with documentation to get pull requests from users with what they learn in the issues discussions?
P.S. I’m thinking of creating a wiki page in my keybase_tools repo mostly for my own reference, but I also could write it in a format that will make it easier to merge that into the official documentation.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reviewing the existing API documentation and the issue discussions referenced in the proposal. The issue names no files, tests, or documentation source, so first determine where the current documentation lives and what repository or format would accept contributions. Done would require an agreed documentation repository and a workable path for incorporating user-written updates.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100