NatLabRockies / NatLabRockies/developer.nlr.gov
Documentation consistency
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 60
- Forks
- 57
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 3
Description
Feedback from our API Usability Testing: We have a few different styles of documentation across our site. If you're browsing the different areas, it would be nice to have more consistency. For example, we have static docs in some places and interactive swagger docs in others.
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
Compare the linked static documentation for Alt Fuel Stations with the interactive Swagger documentation for Transportation Incentives and Laws, then review the API Usability Testing feedback. Define a consistent documentation approach across the site; the work is done when the chosen style and the APIs or documentation areas to update are agreed and applied.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100