nunit / nunit/docs

Move console/engine wiki to docs

Open
#744 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Dockerfile
Stars
600
Forks
158
Avg merge
16h 8m
Merged PRs (30d)
21

Description

Via core team discussion:

The documentation for the console/engine exist both in the console/engine git repository wiki AND in the docs repo, and they are not aligned. I think @rprouse was hit by this when he did the last release, as the current doc actually was in the console repo wiki. Can we get the docs off the console wiki and get it all in one place, in the docs repo?

Seems like a great idea to me.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the console/engine GitHub wiki with the nunit/docs repository to identify documentation that exists in both places and is out of sync. Consolidate the relevant material in the docs repository, then verify that the console/engine wiki no longer remains the source for those documents.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.