NatLabRockies / NatLabRockies/OpenStudio
Update Model SDK Documentation Page
Open
Nobody has claimed this yet.
component - Documentation
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
https://openstudio-sdk-documentation.s3.amazonaws.com/cpp/OpenStudio-2.4.0-doc/model/html/index.html
Link OS to E+ IDD comparison (for each object, and summary on single page), Document Model API conventions
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.
Research direction
Start with the linked OpenStudio Model SDK documentation page and identify where object documentation and Model API conventions are presented. Document the EnergyPlus IDD comparison for each object, add a summary on one page, and cover the API conventions; the documentation is done when both requested topics are available and linked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100