nunit / nunit/docs

Restructure the starting pages

Open
#848 0 comments 0 reactions 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

This page: https://docs.nunit.org/ doubles up what is here: https://docs.nunit.org/articles/nunit/intro.html

Can we move the 2nd to be the 1st ?

And then make the text there more informative?

If you are new to NUnit, we suggest you begin by reading the Getting Started section of this site. Those who have used earlier releases may want to begin with the Upgrading section.

In the NUnit Introduction, which could be the new starting page imho, it refers to the Upgrading section, that don't exist on the same level as Get Started, but is a sub-section of the same. And it is of course outdated and badly informed.

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 site root at https://docs.nunit.org/ with the NUnit Introduction page at https://docs.nunit.org/articles/nunit/intro.html, including the Getting Started and Upgrading sections mentioned in the issue. Restructure the starting-page relationship, update the outdated introductory text and references, and verify that the navigation and links accurately describe the available sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.