Skip to content

Commit 2734b4a

Browse files
docs: add CONTRIBUTOR-DOCS reminder to regenerate nav and verify links
When changing doc structure or headings, point readers to Authoring contributor docs for running the nav script and link verification. (Cursor said it would do a better job if I added this to the documentation.)
1 parent 79f49c8 commit 2734b4a

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTOR-DOCS/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ These docs contain essential information about the SWC project for both maintain
6060

6161
The docs are organized into three main sections to help you find the information you need:
6262

63-
**[Contributor Guides](./01_contributor-guides/README.md)** - Topical guides for working on the project. This section includes guides for getting started, understanding processes, and accomplishing specific tasks like adding new components or editing these contributor docs themselves.
63+
**[Contributor Guides](./01_contributor-guides/README.md)** - Topical guides for working on the project. This section includes guides for getting started, understanding processes, and accomplishing specific tasks like adding new components or editing these contributor docs themselves. When you change doc structure or headings, see [Authoring contributor docs](./01_contributor-guides/07_authoring-contributor-docs/README.md) to regenerate navigation and verify links.
6464

6565
**[Style Guide](./02_style-guide/README.md)** - Comprehensive style guide covering project-wide conventions and area-specific rules. This section is useful for human reference and for AI-assisted work, documenting our approaches to linting, JSDoc conventions, component structure, and other coding standards.
6666

0 commit comments

Comments
 (0)