NatLabRockies / NatLabRockies/developer.nlr.gov
View all available APIs on one page
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: Right now, our browsing of documentation and available APIs is very hierarchal, since you have to drill down via technology type (buildings, transportation, etc). One participant suggested it would be nice to have a way to view all the APIs on a single page. We don't really have that many, so while a technology-based approach might make sense to some, it makes it difficult to get a broad overview of the APIs NREL provides.
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
No file or test is named. Start by locating the technology-type API documentation and navigation pages described in the issue, then determine how the existing API list is assembled. Done means users can open one page and see all APIs NREL provides without drilling into technology categories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100