NatLabRockies / NatLabRockies/OpenStudio
Improving Navigation to Full OpenStudio SDK Documentation
@tijcolem is already working on this.
Since Nov 30, 2022.
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Enhancement Request
Add a link to the Full OpenStudio SDK documentation to the OpenStudio User Documentation navigation bar.
Detailed Description
Right now, finding the link to https://s3.amazonaws.com/openstudio-sdk-documentation/index.html for the full SDK documentation from https://nrel.github.io/OpenStudio-user-documentation/ is pretty tricky. I think it would greatly benefit users to have a link to this documentation within the top navigation menu of the user documentation website. If I hadn't had someone send me to this documentation link before I'm not sure I'd be able to find it just by navigating the user documentation webpage. The only place I can find it is at the top of the first paragraph of the measure code examples page. However, I think there's information valuable to more advanced users even if they're not trying to answer a question about measure writing, and making the link easier to find would benefit them.
Possible Implementation
I think including a link to the full documentation under the References tab of the menu along the top probably makes the most sense. However, I could see it making sense to stick it under the Help tab as well.
Cheers!
Contributor guide
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.
Assessment
This issue has not been assessed yet.