Improve landing page
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
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.
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.
- 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
-
area:breg criticality:p3 documentation triage:needs-implementation
Difficulty 1/5 Under an hour Newbie friendliness 86/100
registrystack/registry-stack#1713 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
posit-dev/ggsql#565 · 1 reaction ·
Maintainers usually reply within 1 day
-
documentation easy good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
lacs-project/sysknife#518 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
qgis/QGIS-Plugins-Website#459 ·
-
bot-found documentation priority: P3
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
madenvel/KalinkaPlayer#178 ·