Convert code samples to executable code
Open
Nobody has claimed this yet.
- Dominant language
- Dockerfile
- Stars
- 600
- Forks
- 158
- Avg merge
- 16h 8m
- Merged PRs (30d)
- 21
Description
Docfx has the ability to pull snippets from other files, including directly from C# code.
This means we can create a real solution/project, host code samples there and iterate on them, and pull the relevant sections into the docs.
Doing this will allow for:
- Verification of sample code
- Easier refactoring of samples to use good practices
- CI checking to ensure samples work and all tests pass
- Ability to show tests that fail too (and to ignore them in CI)
- Easier creation of more complex samples
- Sample code re-use eventually
Work Breakdown
- #702
- Comb the project for other possible snippets and add them to the list here
- Enlist others in populating these snippets in the real project
Snippets, in suggested order of priority:
TBD
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 completed work in #702 and the existing Docfx snippets, then comb the project for additional snippets as requested in the work breakdown. Done means prioritized samples are hosted in a real C# solution or project, pulled into the documentation, and checked by CI where applicable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100