Skip to content

Commit e3ebd74

Browse files
docs: improve and clean up contributor docs for barebones merge (#5840)
* chore: rename COPYRIGHT to HEADER * docs: add minimalistic README and CONTRIBUTING docs * docs: reorganize contributor docs * docs: complete reorganization * docs: move docs from 1st-gen * docs: cleanup * docs: incremental reorg * docs: move style guide back to top level * docs: refactor getting involved and PR docs * docs: add working-in-the-repo doc, make minor edits * chore: fix links, improve link-validation * docs: restore original root README within 1st-gen * docs: link to code of conduct * docs: link to CLA * chore: add comma Co-authored-by: Najika Halsema Yoo <[email protected]> * chore: add link to Stackblitz for repros Co-authored-by: Najika Halsema Yoo <[email protected]> * chore: add link to Stackblitz Co-authored-by: Najika Halsema Yoo <[email protected]> * docs: apply suggestions from review * docs: minor copy edit * docs: fix list formatting Co-authored-by: Najika Halsema Yoo <[email protected]> --------- Co-authored-by: Najika Halsema Yoo <[email protected]>
1 parent 6aa9f5b commit e3ebd74

Some content is hidden

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

46 files changed

+1606
-1007
lines changed
Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,52 @@
11
---
2-
description: Useful for updating auto-generated content in the contributor docs
2+
description: Useful for updating auto-generated navigation and validating links in the contributor docs
33
alwaysApply: false
44
---
5-
If the user requests an update to the contributor docs (located in the CONTRIBUTOR_DOCS folder at the repository root), run the update process as described in the agent instructions within that folder.
65

7-
To locate the instructions, search for "ai-agent-instructions", or fall back to a recursive directory search if needed.
6+
# Contributor docs navigation and link validation
7+
8+
## When to apply this rule
9+
10+
Recognize and apply this rule when the user requests any of the following:
11+
- Update contributor docs navigation
12+
- Update nav / TOC / breadcrumbs in contributor docs
13+
- Regenerate contributor docs
14+
- Validate/verify links in contributor docs
15+
- Fix broken links in contributor docs
16+
- Any mention of "CONTRIBUTOR-DOCS" or "contributor docs" with "update", "nav", "links", or "verify"
17+
18+
## Instructions location
19+
20+
**Primary path:** `CONTRIBUTOR-DOCS/01_contributor-guides/07_authoring-contributor-docs/01_ai-agent-instructions.md`
21+
22+
## What to do
23+
24+
1. **Verify the instructions file exists** at the path above
25+
- If the file exists, read it and follow the instructions for "Role 1: Operator"
26+
- If the file does NOT exist, see "Self-correction procedure" below
27+
28+
2. **Follow the AI agent instructions** to:
29+
- Run the nav update script (which automatically validates links)
30+
- Handle any broken links that are reported
31+
- Report results to the user
32+
33+
## Self-correction procedure
34+
35+
If the instructions file is not found at the expected path:
36+
37+
1. Search for the file using: `glob_file_search` with pattern `**/ai-agent-instructions.md`
38+
2. Filter results to find the one in `CONTRIBUTOR-DOCS/` folder
39+
3. Read the found file to confirm it contains the nav update instructions
40+
4. **Update this rule file** with the new path by modifying the "Primary path" line above
41+
5. Inform the user that you've updated the rule with the new location
42+
6. Continue with the nav update process
43+
44+
## Quick reference
45+
46+
The nav update process typically involves:
47+
- Running a Node.js script in the authoring-contributor-docs folder
48+
- The script automatically updates breadcrumbs, TOC, and validates all links
49+
- If broken links are found, fix straightforward issues automatically
50+
- Only consult the user for ambiguous cases
51+
52+
Execution time is typically 20-200ms for the entire CONTRIBUTOR-DOCS tree.

.eslintrc.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
"plugin:@typescript-eslint/recommended",
1010
"plugin:prettier/recommended"
1111
],
12+
"ignorePatterns": ["CONTRIBUTOR-DOCS/**/*"],
1213
"overrides": [
1314
{
1415
"extends": ["plugin:jsonc/recommended-with-jsonc"],

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Documentation infrastructure scripts maintained by AI agents
2+
CONTRIBUTOR-DOCS/
3+

.stylelintignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
node_modules
2-
COPYRIGHT
2+
HEADER
33
1st-gen/node_modules
44
2nd-gen/node_modules
55
1st-gen/task

.stylelintrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"files": ["**/*.css"],
88
"extends": ["stylelint-config-standard"],
99
"rules": {
10-
"header/header": ["./COPYRIGHT", {}],
10+
"header/header": ["./HEADER", {}],
1111
"length-zero-no-unit": [
1212
true,
1313
{ "ignore": "custom-properties" }

1st-gen/CONTRIBUTING.md

Lines changed: 0 additions & 288 deletions
This file was deleted.

1st-gen/PULL_REQUESTS.md

Lines changed: 0 additions & 217 deletions
This file was deleted.

0 commit comments

Comments
 (0)