Skip to content

Commit 9ad29db

Browse files
Merge pull request #44 from TaskarCenterAtUW/feat/docs-qaqc/2981-add-qaqc-report-guide
Add QA/QC Report User Manual
2 parents d6ab225 + e387814 commit 9ad29db

File tree

85 files changed

+47374
-2046
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+47374
-2046
lines changed

.github/copilot-instructions.md

Lines changed: 92 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010

1111
### Single-Source Documentation Site
1212

13-
- **Framework**: Zensical (`zensical.toml` orchestrates everything)
14-
- **Content**: Markdown files in `/docs` structured by topic
15-
- **Navigation**: Auto-generated from directory structure via PowerShell scripts
16-
- **Custom Extensions**: YAML frontmatter titles, abbreviations auto-linking, custom CSS theming
13+
- **Framework**: Zensical (`zensical.toml` orchestrates everything)
14+
- **Content**: Markdown files in `/docs` structured by topic
15+
- **Navigation**: Auto-generated from directory structure via PowerShell scripts
16+
- **Custom Extensions**: YAML frontmatter titles, abbreviations auto-linking, custom CSS theming
1717

1818
### Directory Structure Pattern
1919

@@ -31,8 +31,8 @@ docs/
3131

3232
### Abbreviations System
3333

34-
- `/includes/abbreviations.md` auto-links acronyms site-wide (e.g., OSW, TDEI, JOSM)
35-
- Add new acronyms here; they're automatically inserted into all `.md` files via the Zensical snippets plugin
34+
- `/includes/abbreviations.md` auto-links acronyms site-wide (e.g., OSW, TDEI, JOSM)
35+
- Add new acronyms here; they're automatically inserted into all `.md` files via the Zensical snippets plugin
3636

3737
## Version Control & Workflow
3838

@@ -42,24 +42,24 @@ This project follows standardized version control conventions:
4242

4343
The TCAT Wiki uses [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH):
4444

45-
- **Major (X.0.0)**:
46-
- Core: New major features or upgrades
47-
- Docs: Changes to structure/navigation that break external links
48-
- **Minor (0.X.0)**:
49-
- Core: Significant changes to core features
50-
- Docs: New documentation or major reworks
51-
- **Patch (0.0.X)**:
52-
- Core: Minor fixes, fixing typos, completing chores
53-
- Docs: Small updates, fixing typos, adding images
45+
- **Major (X.0.0)**:
46+
- Core: New major features or upgrades
47+
- Docs: Changes to structure/navigation that break external links
48+
- **Minor (0.X.0)**:
49+
- Core: Significant changes to core features
50+
- Docs: New documentation or major reworks
51+
- **Patch (0.0.X)**:
52+
- Core: Minor fixes, fixing typos, completing chores
53+
- Docs: Small updates, fixing typos, adding images
5454

5555
The version number is stored in the `version` field in `zensical.toml`.
5656

5757
### Conventional Commits
5858

5959
Commits follow [Conventional Commits](https://www.conventionalcommits.org/) with scoping:
6060

61-
- `feat(scope): description` - Core features or Docs content
62-
- `fix(scope): description` - Core patches or Docs corrections
61+
- `feat(scope): description` - Core features or Docs content
62+
- `fix(scope): description` - Core patches or Docs corrections
6363

6464
Examples:
6565

@@ -94,9 +94,16 @@ fix/docs-walksheds/2048-fix-typo
9494

9595
## Critical Developer Workflows
9696

97-
### Build & Preview Local Site
97+
**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.
98105

99-
This project uses a Python virtual environment (`.venv/`) for dependency isolation.
106+
### Build & Preview Local Site
100107

101108
```powershell
102109
# First time only: create and activate virtual environment
@@ -106,7 +113,7 @@ python -m venv .venv
106113
# Install dependencies from requirements.txt
107114
pip install -r requirements.txt
108115
109-
# Run the local development server
116+
# Run the local development server (venv must be activated)
110117
zensical serve # http://localhost:8000
111118
112119
# Deactivate when done
@@ -118,6 +125,9 @@ deactivate
118125
### Regenerate Navigation After Adding Files
119126

120127
```powershell
128+
# Ensure venv is activated first!
129+
.\.venv\Scripts\Activate.ps1
130+
121131
cd util
122132
.\generate-guides-lists.ps1 # Auto-generates index.md in guides/ directories
123133
.\generate-nav.ps1 # Updates zensical.toml nav section directly
@@ -128,6 +138,9 @@ cd util
128138
### Validate Links
129139

130140
```powershell
141+
# Ensure venv is activated first!
142+
.\.venv\Scripts\Activate.ps1
143+
131144
cd util
132145
.\check-links.ps1 # Check internal + external links
133146
.\check-links.ps1 -internal # Internal only
@@ -139,6 +152,9 @@ cd util
139152
The `run-utils.ps1` script provides an automated workflow to validate and run all utilities:
140153

141154
```powershell
155+
# Ensure venv is activated first!
156+
.\.venv\Scripts\Activate.ps1
157+
142158
cd util
143159
.\run-utils.ps1 # Run all tests, then all utilities
144160
.\run-utils.ps1 -TestsOnly # Run only Pester tests
@@ -207,6 +223,30 @@ tags:
207223

208224
**Exception**: `docs/index.md` has its title commented out to prevent "TCAT Wiki - TCAT Wiki" duplication.
209225

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+
210250
**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):
211251

212252
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.
235275

236276
**User Manuals**: Pages tagged with `- User Manual` are treated as guides but handled specially:
237277

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
241281

242282
### Organization
243283

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)
250-
- **tdei-walkshed**: TDEI Walkshed tool documentation
251-
- **workspaces**: Workspaces editing platform guides
252-
- **resources**: Images and stylesheets (no content pages)
253-
- **local-storage/**: Directory ignored by git, used as a storage target for temporary local files
254-
- **util**: Utilities and scripts to make editing this Wiki easier
284+
- **accessmap**: AccessMap documentation and guides
285+
- **aviv-scoutroute**: AVIV ScoutRoute mobile app user manual and quest definition guides
286+
- **josm**: JOSM configuration guides for Workspaces editing
287+
- **opensidewalks**: OpenSidewalks schema guides (organized in `schema/` and `tasking-manager/` subtopics)
288+
- **rapid**: Rapid editor documentation
289+
- **tdei**: TDEI platform documentation (organized in `portal/` and `tdei-core/` subtopics)
290+
- **tdei-walkshed**: TDEI Walkshed tool documentation
291+
- **workspaces**: Workspaces editing platform guides
292+
- **resources**: Images and stylesheets (no content pages)
293+
- **local-storage/**: Directory ignored by git, used as a storage target for temporary local files
294+
- **util**: Utilities and scripts to make editing this Wiki easier
255295

256296
## Integration Points & Dependencies
257297

258298
### Customizations
259299

260-
- **Theme**: Custom CSS in `/resources/stylesheets/` (ensure file exists before editing)
261-
- **Overrides**: `/overrides/partials/` extends Zensical templates (head.html, extra.html)
300+
- **Theme**: Custom CSS in `/resources/stylesheets/` (ensure file exists before editing)
301+
- **Overrides**: `/overrides/partials/` extends Zensical templates (head.html, extra.html)
262302

263303
## When Adding New Content
264304

@@ -272,11 +312,11 @@ Both flags can be used together to exclude a guide from all guides lists.
272312

273313
**For Guide Content**: The human editor is responsible for writing the substantive content of guides. The AI assistant's role is to:
274314

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
280320

281321
**The assistant should NOT write the core guide content itself!** Guides must reflect the knowledge and perspective of subject matter experts and domain authors.
282322

@@ -290,14 +330,14 @@ Refer to the official Zensical documentation, which is hosted online at https://
290330

291331
### Key Files for Reference
292332

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
343+
- `/resources/stylesheets/extra.css`: Theming

docs/aviv-scoutroute/user-manual/app-settings.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: App Settings
3+
nav_order: 6
34
tags:
45
- Guide
56
- External

docs/aviv-scoutroute/user-manual/completing-quests.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Completing Quests
3+
nav_order: 4
34
tags:
45
- Guide
56
- External

docs/aviv-scoutroute/user-manual/getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Getting Started
3+
nav_order: 2
34
tags:
45
- Guide
56
- External

docs/aviv-scoutroute/user-manual/index.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,32 @@ AVIV ScoutRoute is based on [StreetComplete](https://github.com/westnordost/Stre
3737
- [AVIV ScoutRoute Android Release Notes](https://docs.google.com/document/d/1jaiyNtAOCKeUVBqjmLveI78g4yhWH222DLg7Ev4VO5g/view?usp=sharing)
3838
- [AVIV ScoutRoute iOS Release Notes](https://docs.google.com/document/d/1i9FUVdXElJ8zUk3BTvbW8AOQ-lYz_6Q6c1p8wZXYZxc/view?usp=sharing)
3939

40+
---
41+
4042
### Table of Contents
4143

4244
AVIV ScoutRoute User Manual Table of Contents
4345

44-
#### [App Settings](app-settings.md)
45-
46-
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)
4947

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.
5149

5250
#### [Getting Started](getting-started.md)
5351

5452
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.
5553

56-
#### [Installation](installation.md)
57-
58-
This guide provides platform-specific instructions for installing AVIV ScoutRoute on Android and iOS devices.
59-
6054
#### [Map Interface](map-interface.md)
6155

6256
This guide explains the main AVIV ScoutRoute map interface, including how to navigate the map, understand quest icons, and interpret common pedestrian feature terminology.
6357

58+
#### [Completing Quests](completing-quests.md)
59+
60+
This guide explains how to view, select, answer, submit, and undo quests in AVIV ScoutRoute.
61+
6462
#### [Quest Types](quest-types.md)
6563

6664
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.

docs/aviv-scoutroute/user-manual/installation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Installation
3+
nav_order: 1
34
tags:
45
- Guide
56
- External

docs/aviv-scoutroute/user-manual/map-interface.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Map Interface
3+
nav_order: 3
34
tags:
45
- Guide
56
- External

docs/aviv-scoutroute/user-manual/quest-types.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Quest Types
3+
nav_order: 5
34
tags:
45
- Guide
56
- External

docs/guides-list/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ This user manual explains how to use the [OSM US Tasking Manager](https://tasks.
6666

6767
This guide shows the steps for an automated workflow that generates task polygons for use in Tasking Manager.
6868

69+
### [OS-CONNECT](../os-connect/index.md)
70+
6971
### [Rapid Editor](../rapid/index.md)
7072

7173
#### [Rapid User Manual](../rapid/user-manual/index.md)

docs/javascripts/extra.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@ const titleMapSource = {
2828
ios: "iOS",
2929
mny26: "Mappy New Year 2026",
3030
"olympia connected": "Olympia, Connected",
31-
oswmh: "OpenSidewalks Mappy Hours"
31+
oswmh: "OpenSidewalks Mappy Hours",
32+
"os connect": "OS-CONNECT",
33+
"qa qc": "QA/QC"
3234
};
3335

3436
/**

0 commit comments

Comments
 (0)