chipsalliance / chipsalliance/Surelog
Publish API docs on readthedocs
Open
documentation
infra
- Dominant language
- C++
- Stars
- 475
- Forks
- 90
- Avg merge
- 1h 39m
- Merged PRs (30d)
- 37
Description
Surelog should publish documentation on ReadTheDocs like all good packages.
See https://docs.readthedocs.io/en/stable/ on how to get started.
The docs should be published at https://surelog.readthedocs.io/
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the linked ReadTheDocs setup guide and inspect Surelog's existing documentation entry point. Determine how the API documentation is currently generated, then configure publication at surelog.readthedocs.io and verify that the published API docs are accessible.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100