frederikja163 / frederikja163/Master
Think about public interface
Open
- Dominant language
- C#
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Think about what interface should be public facing and how we will document that interface
We should put xml comments on all public facing documentation. We should probably also have some kind of demo code in the long run.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the project's public-facing interface and deciding which parts should be documented for users. Define the public API documentation scope, add XML comments where agreed, and outline demo code as a future documentation need; completion depends on resolving the interface and documentation design first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100