diff options
Diffstat (limited to 'docs/modules/ROOT/nav.adoc')
-rw-r--r-- | docs/modules/ROOT/nav.adoc | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc new file mode 100644 index 0000000..d4b577b --- /dev/null +++ b/docs/modules/ROOT/nav.adoc | |||
@@ -0,0 +1,17 @@ | |||
1 | // MC: NOTE ABOUT TOC | ||
2 | // Adding "pageroot" attr so that TOC that will also work directly in GitHub. Because... | ||
3 | // In Antora the "pages" subdir is implcit added to the xref path at build time. | ||
4 | // if you add "/pages" Antora will intepret it as "pages/pages". | ||
5 | // The pages subdir is NOT implicit when viewing source files in Github. | ||
6 | |||
7 | ifdef::env-github[:pageroot: pages/] | ||
8 | ifndef::env-github[:pageroot:] | ||
9 | |||
10 | .Guide to the Build Tools | ||
11 | * xref:{pageroot}metaupdater-whatis.adoc[What are the build tools?] | ||
12 | * xref:{pageroot}build.adoc[Build a disk image] | ||
13 | * xref:{pageroot}supported-boards.adoc[Supported Boards] | ||
14 | * xref:{pageroot}meta-updater-usage.adoc[How to] | ||
15 | * xref:{pageroot}sota-variables.adoc[Configuration reference] | ||
16 | * xref:{pageroot}dev-config.adoc[Development configuration] | ||
17 | * xref:{pageroot}meta-updater-testing.adoc[Testing] \ No newline at end of file | ||