microsoft / microsoft/OSSGadget
Generate docs on build and publish to GitHub pages
Open
Nobody has claimed this yet.
documentation
good first issue
pipeline
- Dominant language
- C#
- Stars
- 371
- Forks
- 58
- PR merge metrics
- No merged PRs in 30d
Description
Doc comments are present but I don't believe we currently generate the documentation.
See OAT for an example.
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
The issue mentions existing C# doc comments and an OAT example, but no files, commands, or documentation generator. Start by locating the repository build configuration and the doc comments, then compare the documentation workflow with the OAT example. Done means documentation is generated during the build and published to GitHub Pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, github
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100