Clean up orphaned service-level and package-level overviews
- Dominant language
- C#
- Stars
- 135
- Forks
- 260
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 115
Description
Files to look for
- `*-readme.md` -- package-level overview
- `.md` -- service-level overview
- `*-index.md` -- package list in service-level overview
Look at onboarded packages, if any -readme.md files don't match onboarded they are candidates for removal. If onboarded packages' services do not match a given `.md` file it is a candidate for removal. If any `*-index.md` files are not included in any other `.md` files then they are candidates for removal.
This should be done with respect to latest and preview monikers for each language.
Contributor guide
Research direction
Inventory `*-readme.md`, `.md`, and `*-index.md` files, then compare them with onboarded packages and services for both latest and preview monikers. Start by tracing which package lists each service overview includes. Done means every candidate is validated against the onboarded set and obsolete overviews or unreferenced package indexes are removed.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100