You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .claude/docs/documentation.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,15 @@ Both `README.md` and `docs/REFERENCE.md` use back-to-top navigation after each m
7
7
1. Add `<p align="right"><a href="#table-of-contents">⬆️ back to top</a></p>` before the `---` that closes the section
8
8
2. Update the Table of Contents with the new entry
9
9
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
11
19
12
20
Each file in `docs/overview/` follows this layout:
13
21
@@ -17,7 +25,7 @@ Each file in `docs/overview/` follows this layout:
17
25
4.**`---`** separator
18
26
5.**Footer nav** — `<small>` block with the same `` `Previous` ``/`` `Next` `` links as the header
19
27
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`.
0 commit comments