Add DocFX Documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- C#
- Stars
- 5.3k
- Forks
- 510
- Avg merge
- 8d 5h
- Merged PRs (30d)
- 5
Description
Since the API looks well commented with XML comments, it'd be handy at least until full example documentation could be written, to have a DocFX site for at least the API docs.
This could make it a bit easier to see a breakdown and relations of certain API calls and the relations between objects and such.
Thanks!
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
No source file, test, or entry point is named. Start by locating the C# API XML comments and the repository's documentation or build configuration, then define done as a DocFX site that publishes the API documentation and shows relevant API and object relationships.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100