Convert code samples to executable code
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation, testing
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.
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
- Dominant language
- Dockerfile
- Stars
- 601
- Forks
- 158
- Avg merge
- 15h 46m
- Merged PRs (30d)
- 23
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from nunit/docs
-
type:newpage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
area:framework
Difficulty 4/5 3-5 days Newbie friendliness 40/100
Maintainers usually reply within 1 day
-
Document F# EqualToOpenarea:framework
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
area:framework
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
nunit/docs#1045 · 6 comments ·
Maintainers usually reply within 1 day
Similar issues
-
copilot documentation
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 2 days
-
external-issue to-triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 2 days
-
skill:code-review
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day