nunit / nunit/docs

Improve landing page

Open
#779 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

The landing page could need some updates.
We don't need to give the legacy documentation that much focus now.
The documentation is now focused around how we have built NUnit, and less about how to use NUnit. We should focus on the latter, but still provide good visible links to the reference sections, the developer details and other stuff that could be usable to contributors and developers.

  • Move legacy documentation into its own sub-page #809
  • Add a section for announcements
  • Add a section for tutorials, with "How to" information
  • Add information on where to find different stuff around NUnit, the repos we have, Microsoft/dotnet related information and so on

This can be just section headers with links to subpages, or some other nice way of getting a good landing page.

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

Start at the current documentation landing page and review how legacy documentation, usage guidance, reference sections, and contributor information are presented. Add visible sections or links for announcements, tutorials, NUnit resources, repositories, and Microsoft/.NET information, while retaining useful links to reference and developer content.

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.