Skip to content

Commit 8a2bab1

Browse files
Merge pull request #2401 from jasonrandrews/review
update AI tool instructions
2 parents 4f3cacd + 7de90dc commit 8a2bab1

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

.github/copilot-instructions.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Read the files in the directory `content/learning-paths/cross-platform/_example-
4545

4646
Each Learning Path must have an _index.md file and a _next-steps.md file. The _index.md file contains the main content of the Learning Path. The _next-steps.md file contains links to related content and is included at the end of the Learning Path.
4747

48+
Additional resources and 'next steps' content should be placed in the `further_reading` section of `_index.md`, NOT in `_next-steps.md`. The `_next-steps.md` file should remain minimal and unmodified as indicated by "FIXED, DO NOT MODIFY" comments in the template.
49+
4850
The _index.md file should contain the following front matter and content sections:
4951

5052
Front Matter (YAML format):
@@ -60,6 +62,16 @@ Front Matter (YAML format):
6062
- `skilllevels`: Skill levels allowed are only Introductory and Advanced
6163
- `operatingsystems`: Operating systems used, must match the closed list on https://learn.arm.com/learning-paths/cross-platform/_example-learning-path/write-2-metadata/
6264

65+
### Further Reading Curation
66+
67+
Limit further_reading resources to 4-6 essential links. Prioritize:
68+
- Direct relevance to the topic
69+
- Arm-specific Learning Paths over generic external resources
70+
- Foundation knowledge for target audience
71+
- Required tools (install guides)
72+
- Logical progression from basic to advanced
73+
74+
Avoid overwhelming readers with too many links, which can cause them to leave the platform.
6375

6476
All Learning Paths should generally include:
6577
Title: [Imperative verb] + [technology/tool] + [outcome]
@@ -205,18 +217,23 @@ Some links are useful in content, but too many links can be distracting and read
205217

206218
### Internal links
207219

208-
Use a relative path format for internal links that are on learn.arm.com.
209-
For example, use: descriptive link text pointing to a relative path like learning-paths/category/path-name/
220+
Use the full path format for internal links: `/learning-paths/category/path-name/` (e.g., `/learning-paths/cross-platform/docker/`). Do NOT use relative paths like `../path-name/`.
210221

211222
Examples:
212-
- learning-paths/servers-and-cloud-computing/csp/ (Arm-based instance)
213-
- learning-paths/cross-platform/docker/ (Docker learning path)
223+
- /learning-paths/servers-and-cloud-computing/csp/ (Arm-based instance)
224+
- /learning-paths/cross-platform/docker/ (Docker learning path)
214225

215226
### External links
216227

217228
Use the full URL for external links that are not on learn.arm.com, these open in a new tab.
218229

219-
This instruction set enables high-quality Arm Learning Paths content while maintaining consistency and technical accuracy.
220-
230+
### Link Verification Process
221231

232+
When creating Learning Path content:
233+
- Verify internal links exist before adding them
234+
- Use semantic search or website browsing to confirm Learning Path availability
235+
- Prefer verified external authoritative sources over speculative internal links
236+
- Test link formats against existing Learning Path examples
237+
- Never assume Learning Paths exist without verification
222238

239+
This instruction set enables high-quality Arm Learning Paths content while maintaining consistency and technical accuracy.

0 commit comments

Comments
 (0)