Skip to content

Commit 27729a8

Browse files
Merge pull request #2810 from annietllnd/main
Add review-guidelines.md
2 parents 1f7cef3 + 9b9ca89 commit 27729a8

3 files changed

Lines changed: 85 additions & 1 deletion

File tree

.github/review-guidelines.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
### Maintenance checks for Learning Paths and Install Guides
2+
3+
Please review the content in the specified content path and support my manual review by:
4+
5+
1. **Summarizing what this guide does**
6+
- What the end goal is
7+
- What platform(s) and environments it targets
8+
- Any key assumptions the reader must meet
9+
10+
2. **Identifying dependencies and moving parts**
11+
- OS, architecture, toolchains, frameworks, SDKs
12+
- External repositories, models, downloads, or services
13+
- Commands or workflows that are central to the guide
14+
15+
3. **Flagging potential risk areas**
16+
- References to old OS versions, runtimes, or toolchains
17+
- Dependencies that may be stale, deprecated, or fragile
18+
- Links or resources that might require checking
19+
- Steps that rely heavily on UI flows or screenshots
20+
21+
4. **Calling out anything that may need a closer human look**
22+
- Ambiguous or unclear instructions
23+
- Areas where “latest” or unpinned versions are used
24+
- Places where ecosystem changes could affect correctness
25+
26+
---
27+
28+
### How to behave
29+
30+
- Be conservative and transparent — if something is uncertain, say so.
31+
- Prefer **flagging** over **fixing**.
32+
- Do not invent new commands, tools, or workflows.
33+
- If suggesting changes, keep them minimal and clearly optional.
34+
- Treat this as a *conversation starter* for the reviewer, not a final verdict.
35+
36+
---
37+
38+
### Output format (keep it lightweight)
39+
40+
Please respond with:
41+
- A short summary of the guide
42+
- A bulleted list of dependencies
43+
- A bulleted list of review flags or questions to consider
44+
45+
No code changes are required unless I explicitly ask for them.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
# User change
3+
title: "Maintaining the content"
4+
5+
weight: 10 # 1 is first, 2 is second, etc.
6+
7+
# Do not modify these elements
8+
layout: "learningpathall"
9+
---
10+
## How to review a Learning Path
11+
12+
Keeping Learning Paths and Install Guides up to date is an ongoing responsibility. The goal of content maintenance is to ensure that guides remain technically correct as tools, platforms, and dependencies constantly evolve.
13+
14+
When reviewing content, focus on identifying risk, drift, and breakage that could impact a user’s ability to successfully follow the guide today. Look for issues such as:
15+
16+
### Outdated dependencies or assumptions
17+
18+
* Old OS versions, runtimes, or toolchains
19+
* Deprecated frameworks, libraries, or models
20+
* Hardware assumptions that may no longer hold
21+
22+
23+
### Ecosystem changes
24+
25+
* Referenced repositories that are archived or inactive
26+
* Installation methods or CLIs that have changed
27+
* External services or downloads that no longer exist or have moved
28+
29+
### Version drift and ambiguity
30+
31+
* Use of “latest” without version context
32+
* Missing or unclear compatibility guidance
33+
* Mismatches between stated prerequisites and actual steps
34+
35+
### Trust and usability signals
36+
37+
* Broken or redirected links
38+
* UI instructions or screenshots that no longer match reality
39+
* Formatting or rendering issues that undermine confidence

content/learning-paths/cross-platform/_example-learning-path/questions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Common questions"
33

4-
weight: 10
4+
weight: 11
55

66
layout: "learningpathall"
77
---

0 commit comments

Comments
 (0)