Skip to content

Commit a585413

Browse files
Merge pull request #2851 from ArmDeveloperEcosystem/main
Production update
2 parents 0e90949 + f9e409c commit a585413

File tree

289 files changed

+9525
-2615
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

289 files changed

+9525
-2615
lines changed

.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.

.github/workflows/spell-and-link-check.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ jobs:
5353
path: htmltest.log
5454
retention-days: 5
5555

56+
- name: Generate spell check configuration
57+
run: tools/generate-spellcheck-non-draft.sh
58+
5659
- name: Spell check
5760
id: spellcheck
5861
continue-on-error: true
5962
uses: rojopolis/[email protected]
6063
with:
61-
config_path: .spellcheck.yml
64+
config_path: .spellcheck-non-draft.yml
6265
task_name: Markdown
6366
output_file: spellcheck-output.txt
6467

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,7 @@ z_local_saved/
2323
*.xml
2424

2525
# CTags symbol index
26-
tags
26+
tags
27+
28+
# Generated spell check config
29+
.spellcheck-non-draft.yml

0 commit comments

Comments
 (0)