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
**IMPORTANT**: This project uses a Python virtual environment (`.venv/`) for dependency isolation. **Always activate the virtual environment before running any commands** (including `zensical serve`, utility scripts, etc.):
98
+
99
+
```powershell
100
+
# Activate the virtual environment (run from repository root)
101
+
.\.venv\Scripts\Activate.ps1
102
+
```
103
+
104
+
You'll know the venv is activated when you see `(.venv)` at the beginning of your PowerShell prompt.
98
105
99
-
This project uses a Python virtual environment (`.venv/`) for dependency isolation.
106
+
### Build & Preview Local Site
100
107
101
108
```powershell
102
109
# First time only: create and activate virtual environment
@@ -106,7 +113,7 @@ python -m venv .venv
106
113
# Install dependencies from requirements.txt
107
114
pip install -r requirements.txt
108
115
109
-
# Run the local development server
116
+
# Run the local development server (venv must be activated)
110
117
zensical serve # http://localhost:8000
111
118
112
119
# Deactivate when done
@@ -118,6 +125,9 @@ deactivate
118
125
### Regenerate Navigation After Adding Files
119
126
120
127
```powershell
128
+
# Ensure venv is activated first!
129
+
.\.venv\Scripts\Activate.ps1
130
+
121
131
cd util
122
132
.\generate-guides-lists.ps1 # Auto-generates index.md in guides/ directories
123
133
.\generate-nav.ps1 # Updates zensical.toml nav section directly
The `run-utils.ps1` script provides an automated workflow to validate and run all utilities:
140
153
141
154
```powershell
155
+
# Ensure venv is activated first!
156
+
.\.venv\Scripts\Activate.ps1
157
+
142
158
cd util
143
159
.\run-utils.ps1 # Run all tests, then all utilities
144
160
.\run-utils.ps1 -TestsOnly # Run only Pester tests
@@ -207,6 +223,30 @@ tags:
207
223
208
224
**Exception**: `docs/index.md` has its title commented out to prevent "TCAT Wiki - TCAT Wiki" duplication.
209
225
226
+
**Custom Page Ordering with nav_order**: By default, pages within a directory are sorted alphabetically. To specify a custom order, add the `nav_order` frontmatter property with an integer value. Pages with `nav_order` are sorted by their value (ascending, lower numbers first), followed by pages without `nav_order` (sorted alphabetically). This ordering is local to each directory and applies consistently across navigation structure, parent guides sections, and the main guides list.
227
+
228
+
Example of ordered pages in a user manual:
229
+
230
+
```yaml
231
+
---
232
+
title: Introduction
233
+
tags:
234
+
- Guide
235
+
nav_order: 1
236
+
---
237
+
```
238
+
239
+
```yaml
240
+
---
241
+
title: Getting Started
242
+
tags:
243
+
- Guide
244
+
nav_order: 2
245
+
---
246
+
```
247
+
248
+
Pages without `nav_order` will appear after all ordered pages, sorted alphabetically.
249
+
210
250
**Excluding Guides from Guides Lists**: By default, guides appear in both their parent page's guides list and in the main guides list. You can control where each guide appears using frontmatter flags (YAML comments, invisible on the built page):
211
251
212
252
To exclude a guide from its parent's guides section:
@@ -235,30 +275,30 @@ Both flags can be used together to exclude a guide from all guides lists.
235
275
236
276
**User Manuals**: Pages tagged with `- User Manual` are treated as guides but handled specially:
237
277
238
-
-They appear as single entries in parent guides sections (not as section headers)
239
-
-In the main guides list, only the user manual itself appears, not its subpages
240
-
-Their subpages (e.g., `workspace-settings.md`) appear only in the user manual's own `## Guides` section
278
+
- They appear as single entries in parent guides sections (not as section headers)
279
+
- In the main guides list, only the user manual itself appears, not its subpages
280
+
- Their subpages (e.g., `workspace-settings.md`) appear only in the user manual's own `## Guides` section
241
281
242
282
### Organization
243
283
244
-
-**accessmap**: AccessMap documentation and guides
245
-
-**aviv-scoutroute**: AVIV ScoutRoute mobile app user manual and quest definition guides
246
-
-**josm**: JOSM configuration guides for Workspaces editing
247
-
-**opensidewalks**: OpenSidewalks schema guides (organized in `schema/` and `tasking-manager/` subtopics)
248
-
-**rapid**: Rapid editor documentation
249
-
-**tdei**: TDEI platform documentation (organized in `portal/` and `tdei-core/` subtopics)
@@ -272,11 +312,11 @@ Both flags can be used together to exclude a guide from all guides lists.
272
312
273
313
**For Guide Content**: The human editor is responsible for writing the substantive content of guides. The AI assistant's role is to:
274
314
275
-
-Help with **formatting and structure** (headings, lists, code blocks, links)
276
-
-**Review and suggest improvements** to clarity, tone, and organization
277
-
-**Check logic and consistency** across the documentation
278
-
-**Ensure compliance** with project conventions (frontmatter, tags, abbreviations, etc.)
279
-
-**Proofread** for grammar and spelling
315
+
- Help with **formatting and structure** (headings, lists, code blocks, links)
316
+
-**Review and suggest improvements** to clarity, tone, and organization
317
+
-**Check logic and consistency** across the documentation
318
+
-**Ensure compliance** with project conventions (frontmatter, tags, abbreviations, etc.)
319
+
-**Proofread** for grammar and spelling
280
320
281
321
**The assistant should NOT write the core guide content itself!** Guides must reflect the knowledge and perspective of subject matter experts and domain authors.
282
322
@@ -290,14 +330,14 @@ Refer to the official Zensical documentation, which is hosted online at https://
290
330
291
331
### Key Files for Reference
292
332
293
-
-`zensical.toml`: Main config; nav section auto-updated by scripts
294
-
-`util/run-utils.ps1`: Master utility runner - tests and runs all utilities in sequence
295
-
-`util/run-utils.Tests.ps1`: Pester tests for utility runner
296
-
-`util/generate-guides-lists.ps1`: Creates guide index markdown files
297
-
-`util/generate-guides-lists.Tests.ps1`: Pester tests for guides lists generator
298
-
-`util/generate-nav.ps1`: Builds TOML navigation tree from file structure
299
-
-`util/generate-nav.Tests.ps1`: Pester tests for nav generator
300
-
-`util/check-links.ps1`: PowerShell validation of links (not standard CI integration)
301
-
-`util/check-links.Tests.ps1`: Pester tests for link checker
302
-
-`/includes/abbreviations.md`: Global acronym definitions
303
-
-`/resources/stylesheets/extra.css`: Theming
333
+
-`zensical.toml`: Main config; nav section auto-updated by scripts
334
+
-`util/run-utils.ps1`: Master utility runner - tests and runs all utilities in sequence
335
+
-`util/run-utils.Tests.ps1`: Pester tests for utility runner
336
+
-`util/generate-guides-lists.ps1`: Creates guide index markdown files
337
+
-`util/generate-guides-lists.Tests.ps1`: Pester tests for guides lists generator
338
+
-`util/generate-nav.ps1`: Builds TOML navigation tree from file structure
339
+
-`util/generate-nav.Tests.ps1`: Pester tests for nav generator
340
+
-`util/check-links.ps1`: PowerShell validation of links (not standard CI integration)
341
+
-`util/check-links.Tests.ps1`: Pester tests for link checker
342
+
-`/includes/abbreviations.md`: Global acronym definitions
This guide provides a complete reference for all settings, controls, and features available in AVIV ScoutRoute.
47
-
48
-
#### [Completing Quests](completing-quests.md)
46
+
#### [Installation](installation.md)
49
47
50
-
This guide explains how to view, select, answer, submit, and undo quests in AVIV ScoutRoute.
48
+
This guide provides platform-specific instructions for installing AVIV ScoutRoute on Android and iOS devices.
51
49
52
50
#### [Getting Started](getting-started.md)
53
51
54
52
This guide walks you through your first steps after installing AVIV ScoutRoute, including logging in, selecting a workspace, understanding basic concepts, and completing your first quest.
55
53
56
-
#### [Installation](installation.md)
57
-
58
-
This guide provides platform-specific instructions for installing AVIV ScoutRoute on Android and iOS devices.
59
-
60
54
#### [Map Interface](map-interface.md)
61
55
62
56
This guide explains the main AVIV ScoutRoute map interface, including how to navigate the map, understand quest icons, and interpret common pedestrian feature terminology.
63
57
58
+
#### [Completing Quests](completing-quests.md)
59
+
60
+
This guide explains how to view, select, answer, submit, and undo quests in AVIV ScoutRoute.
61
+
64
62
#### [Quest Types](quest-types.md)
65
63
66
64
This guide provides a detailed reference for each quest input type you'll encounter in AVIV ScoutRoute.
65
+
66
+
#### [App Settings](app-settings.md)
67
+
68
+
This guide provides a complete reference for all settings, controls, and features available in AVIV ScoutRoute.
0 commit comments