[chore] Highlight docs which are draft, WIP, out-of-date, etc.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
What do we need to do?
Identify documents in various state in the front-matter and turn this into a page banner with links to contributing to docs, etc.
For example:
---
title: Question bank
draft:
issueNumber: 99
trackerIssue: MDL-12345
tags:
- draft
---
Could be turned into a banner which links to the devdocs issue with information, and the Tracker issue (if relevant), and provides links to the devdocs contributing docs, etc.
Similarly a Draft tag could warn users that this page is a draft and may not be complete, and to see issue # for more information or provide feedback.
Contributor 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.
Research direction
Start by locating how document front-matter is read and where page banners are rendered. Trace how draft, WIP, and out-of-date states could expose issue and tracker links, then compare the result with the documentation contribution links described in the issue; done means relevant document states show the appropriate warning and links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100