Skip to content

Commit 286874e

Browse files
author
test-runner
committed
feat(docs): add minor issue intake
human-override: no-verify override-note: user requested commit and push with workarounds
1 parent 134136c commit 286874e

7 files changed

Lines changed: 442 additions & 67 deletions

File tree

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Minor Docs Page Issue (Fast Track)
2+
description: Report a small page-scoped reviewer finding such as spelling, broken links, minor copy defects, or lightweight formatting issues.
3+
title: "[minor-docs] <page + short issue summary>"
4+
labels: ["docs-v2", "help wanted", "status: needs-triage", "type: documentation", "scope: page"]
5+
assignees:
6+
- copilot
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Use this fast-track form only for one small page issue at a time.
12+
13+
Use `02_docs_page_issue.yml` instead when the problem involves factual accuracy, missing context, IA, user journey, or larger structural fixes.
14+
15+
- type: input
16+
id: page_or_path
17+
attributes:
18+
label: Page URL or file path
19+
description: Include the exact docs URL or repository path for the affected page.
20+
placeholder: https://docs.livepeer.org/v2/... or v2/...
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: minor_issue
26+
attributes:
27+
label: Minor issue
28+
description: Describe one small issue only.
29+
placeholder: Broken link in the "Run a Gateway" section; the href returns 404.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: evidence
35+
attributes:
36+
label: Evidence / exact broken text or URL
37+
description: Optional quote, broken URL, anchor, or other exact evidence.
38+
placeholder: https://docs.livepeer.org/v2/.../old-link or "orhcestrator" in heading text
39+
validations:
40+
required: false
41+
42+
- type: checkboxes
43+
id: checks
44+
attributes:
45+
label: Submission checks
46+
options:
47+
- label: I am reporting one minor page issue only.
48+
required: true
49+
- label: I provided the exact page and issue so Copilot can action it directly.
50+
required: true

.github/ISSUE_TEMPLATE/docs-review.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ body:
1818
value: |
1919
## 📄 Docs Review
2020
This is a meta review issue for batching feedback across multiple pages.
21-
Use child/actionable issues for page-level fixes and apply `classification:*` there.
21+
Use `07_minor_page_issue.yml` for spelling, broken links, minor copy, or small formatting defects.
22+
Use `02_docs_page_issue.yml` for larger page-level content, IA, accuracy, or navigation fixes and apply `classification:*` there.
2223
2324
Below is the auto-generated review table:
2425

0 commit comments

Comments
 (0)