parse-community / parse-community/Parse-SDK-dotNET
API Doc Generation
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 335
- Forks
- 258
- PR merge metrics
- No merged PRs in 30d
Description
Existing API docs should be updated as the master is moved along. Ideally this will be incorporated into our CI as a automatic action on merging into the master. This issue is just in place so we can formally track this in our 1.8.0 project.
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 by reviewing the existing API docs at http://parseplatform.org/Parse-SDK-dotNET/api/ and how documentation is currently generated for the master branch. Determine the changes needed to keep the docs current and whether CI can run the generation when changes are merged into master. Done means the API docs are updated and the automated workflow is defined for the 1.8.0 tracking goal.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100