Skip to content

Commit 6d7f430

Browse files
committed
update building blocks
1 parent 7887ee2 commit 6d7f430

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/building-blocks/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,25 @@ Links from your documentation to other documentation sets. Validated against pub
4444

4545
Links from other documentation sets to yours. Validated to prevent breaking changes when you move or delete content.
4646

47+
## Navigation
48+
49+
### Documentation Set Navigation
50+
51+
A documentation set is responsible for defining how files are organized in the navigation. This is done by defining a `toc` section in the `docset.yml` file.
52+
If the `toc` section becomes to big folders can define a dedicated `toc.yml` file to organize the files and link them in their parent `toc.yml` or `docset.yml` file.
53+
54+
Read more details in the reference for [docset.yml](../configure/content-set/index.md)
55+
56+
### Global Navigation
57+
58+
The global navigation is defined in the [`navigation.yml`](../configure/site/navigation.md) file.
59+
This navigation only concerns itself with `toc` sections defined in either `docset.yml` or `toc.yml` files.
60+
These `toc` sections can be reorganized independently of their position in the documentation set navigation.
61+
62+
Dangling `toc` sections are **not** allowed and the assembler build will report an error if it finds any. All `toc` sections must be linked in `navigation.yml`.
63+
64+
Read more details in the reference for [navigation.yml](../configure/site/navigation.md)
65+
4766
## How it all works together
4867

4968
1. Each repository builds its documentation set independently

0 commit comments

Comments
 (0)