Skip to content

Commit bb23f78

Browse files
committed
Restructure documentation conventions with breadcrumb nav section
Extract breadcrumb navigation into its own section, add REFERENCE.md nav docs, and fix overview Previous link path to match actual targets.
1 parent 5eea4f9 commit bb23f78

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

.claude/docs/documentation.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ Both `README.md` and `docs/REFERENCE.md` use back-to-top navigation after each m
77
1. Add `<p align="right"><a href="#table-of-contents">⬆️ &nbsp;back to top</a></p>` before the `---` that closes the section
88
2. Update the Table of Contents with the new entry
99

10-
## Overview File Structure
10+
## Breadcrumb Navigation
11+
12+
Both `docs/REFERENCE.md` and all `docs/overview/` files use header and footer nav blocks with `Previous`/`Next` links wrapped in `<small>` tags.
13+
14+
### REFERENCE.md
15+
16+
Uses the same layout as overview files (header nav → `---` → content → `---` → footer nav). Its `Previous` links to `../README.md#-table-of-contents-` and `Next` links to `overview/010_KEY_CONCEPTS.md`.
17+
18+
### Overview Files
1119

1220
Each file in `docs/overview/` follows this layout:
1321

@@ -17,7 +25,7 @@ Each file in `docs/overview/` follows this layout:
1725
4. **`---`** separator
1826
5. **Footer nav**`<small>` block with the same `` `Previous` ``/`` `Next` `` links as the header
1927

20-
Navigation chain: `010_KEY_CONCEPTS``020_BASIC_USAGE` → … → `100_PORTS_AND_ADAPTERS`. The first file's `Previous` links to `../README.md#further-reading`; the last file's `Next` links to `../REFERENCE.md`.
28+
Navigation chain: `010_KEY_CONCEPTS``020_BASIC_USAGE` → … → `100_PORTS_AND_ADAPTERS`. The first file's `Previous` links to `../../README.md#-table-of-contents-`; the last file's `Next` links to `../REFERENCE.md`.
2129

2230
When adding a new overview file:
2331

0 commit comments

Comments
 (0)