Merge pull request #39 from TaskarCenterAtUW/feat/docs-osw/2936-add-OSW0.3-readme

Add OSW0.3 README with link to Metrics

Author: uw-amy-bordenave

docs/CONTRIBUTING.md

@@ -8,7 +8,7 @@ tags:
 
 <!-- @format -->
 
-# Contributing
+## Contributing
 
 This guide explains how to contribute to the TCAT Wiki.
 
@@ -18,32 +18,32 @@ _For a list of all guides on the TCAT Wiki, refer to the [Guides List](guides-li
 
 ---
 
-## Version Control & Workflow
+### Version Control & Workflow
 
 This project follows standardized version control conventions:
 
-### Semantic Versioning
+#### Semantic Versioning
 
 The TCAT Wiki uses [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH):
 
--   **Major (X.0.0)**:
-    -   Core: New major features or upgrades
-    -   Docs: Changes to structure/navigation that break external links
--   **Minor (0.X.0)**:
-    -   Core: Significant changes to core features
-    -   Docs: New documentation or major reworks
--   **Patch (0.0.X)**:
-    -   Core: Minor fixes, fixing typos, completing chores
-    -   Docs: Small updates, fixing typos, adding images
+- **Major (X.0.0)**:
+    - Core: New major features or upgrades
+    - Docs: Changes to structure/navigation that break external links
+- **Minor (0.X.0)**:
+    - Core: Significant changes to core features
+    - Docs: New documentation or major reworks
+- **Patch (0.0.X)**:
+    - Core: Minor fixes, fixing typos, completing chores
+    - Docs: Small updates, fixing typos, adding images
 
 The version number is stored in the `version` field in `zensical.toml`.
 
-### Conventional Commits
+#### Conventional Commits
 
 Commits follow [Conventional Commits](https://www.conventionalcommits.org/) with scoping:
 
--   `feat(scope): description` - Core features or Docs content
--   `fix(scope): description` - Core patches or Docs corrections
+- `feat(scope): description` - Core features or Docs content
+- `fix(scope): description` - Core patches or Docs corrections
 
 Examples:
 
@@ -54,7 +54,7 @@ fix(core-util): fix nav generator logic
 fix(docs-walksheds): fix typo
 ```
 
-### Branch Naming
+#### Branch Naming
 
 Follow GitHub flow with structured branch names:
 
@@ -69,18 +69,18 @@ fix/core-util/9876-fix-nav-generator-logic
 fix/docs-walksheds/2048-fix-typo
 ```
 
-### Pull Request & Release Process
+#### Pull Request & Release Process
 
 1. Create a feature branch following the naming convention
 2. Make commits using conventional commit format
 3. Open a pull request to `main`
 4. Upon merge to `main`, releases are automated
 
-## Getting Started (Windows 10/11)
+### Getting Started (Windows 10/11)
 
 This section of the guide explains how to set up a Windows environment for contributing to the TCAT Wiki for the first time.
 
-### Legend
+#### Legend
 
 1. Keyboard shortcut to press | Action
 
@@ -90,12 +90,10 @@ This section of the guide explains how to set up a Windows environment for contr
 
     [`someCommand --arguments \<path>`]
 
-### Installation and Setup
+#### Installation and Setup
 
 1. Install [Visual Studio Code](https://code.visualstudio.com/)
-
     1. Install VS Code Extensions
-
         1. [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
 
         2. [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
@@ -116,7 +114,6 @@ This section of the guide explains how to set up a Windows environment for contr
 3. Install [Python](https://www.python.org/downloads/)
 
 4. Set up Python virtual environment
-
     1. Create the virtual environment
 
         ```powershell
@@ -129,17 +126,17 @@ This section of the guide explains how to set up a Windows environment for contr
         .\.venv\Scripts\Activate.ps1
         ```
 
- 5. Install requirements
+5. Install requirements
 
     ```powershell
     pip install -r requirements.txt
     ```
 
-## Editing Instructions
+### Editing Instructions
 
 Refer to the documentation for [Zensical](https://zensical.org/docs/).
 
-### Guide Files
+#### Guide Files
 
 By default, guides appear in both their parent page's guides section and in the main guides list. You can control this using frontmatter flags (YAML comments, invisible on the built page).
 
@@ -167,7 +164,7 @@ tags:
 
 Both flags can be used together to exclude a guide from all guides lists.
 
-### Images
+#### Images
 
 Where possible, follow these guidelines for images:
 
@@ -181,7 +178,7 @@ Where possible, follow these guidelines for images:
 
 Refer to [Zensical: Images](https://zensical.org/docs/authoring/images/) for more information.
 
-#### Screenshots
+##### Screenshots
 
 For creating screenshots with a consistent style, Firefox DevTools is to be used.
 
@@ -194,51 +191,43 @@ For creating screenshots with a consistent style, Firefox DevTools is to be used
     (`Ctrl`+`Shift`+`M`)
 
 3. Add custom device profiles:
-
     1. Name: `[Screenshot] Web - Portrait`
-
         1. Size: `671`x`1196`
 
         2. Device Pixel Ratio: `1`
 
         3. User Agent String: `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:140.0) Gecko/20100101 Firefox/140.0`
 
     2. Name: `[Screenshot] Web - Landscape`
-
         1. Size: `1196`x`671`
 
         2. Device Pixel Ratio: `1`
 
         3. User Agent String: `Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:140.0) Gecko/20100101 Firefox/140.0`
 
 4. Resulting screenshots will fit exactly within the 2px outside border present in the following screenshot templates:
-
     1. [Screenshot (Landscape)](resources/images/template/screenshot-landscape.png)
 
     2. [Screenshot (Portrait)](resources/images/template/screenshot-portrait.png)
 
 5. It is recommended to remove all embedded metadata, such as with the use of [ExifToolGUI](https://exiftool.org/gui/).
 
-#### Image Annotations
+##### Image Annotations
 
 For creating image annotations with a consistent style, follow these guidelines.
 
 1. Highlight box
-
     2. Use: Indicating an area of focus in an image.
 
     3. Style
-
         1. Padding: `2px` distance from highlighted selection
 
         2. Outline
-
             1. Width: `1px`
 
             2. Color: `#4B2E83` ("Husky "Purple")
 
         3. Fill
-
             1. Color: `#FFC700` ("Spirit Gold")
 
             2. Opacity: `0.25`
@@ -248,16 +237,15 @@ For creating image annotations with a consistent style, follow these guidelines.
         ![Screenshot of TDEI Portal Login page with "Forgot Password?" highlighted.](resources/images/tdei-portal/login-h-forgot-password.png){ loading=lazy }
 
     5. Naming convention: For images with highlights, append `-h-$highlightedFeature`
-
         1. Example: `login.png` → `login-h-forgot-password.png`
 
-#### QR Codes
+##### QR Codes
 
 1. Create QR codes using [Project Nayuki's QR Code generator library](https://github.com/nayuki/QR-Code-generator).
 
-## Markdown Guide
+### Markdown Guide
 
-### Headers
+#### Headers
 
 ```
 # H1 Header
@@ -268,7 +256,7 @@ For creating image annotations with a consistent style, follow these guidelines.
 ###### H6 Header
 ```
 
-### Text formatting
+#### Text formatting
 
 ```
 **bold text**
@@ -278,7 +266,7 @@ For creating image annotations with a consistent style, follow these guidelines.
 `inline code`
 ```
 
-### Links and images
+#### Links and images
 
 ```
 [Link text](https://example.com)
@@ -287,7 +275,7 @@ For creating image annotations with a consistent style, follow these guidelines.
 ![Image with title](image.jpg "Image title")
 ```
 
-### Lists
+#### Lists
 
 ```
 Unordered:
@@ -301,15 +289,15 @@ Ordered:
 3. Third item
 ```
 
-### Blockquotes
+#### Blockquotes
 
 ```
 > This is a blockquote
 > Multiple lines
 >> Nested quote
 ```
 
-### Code blocks
+#### Code blocks
 
 ````
 ```javascript
@@ -319,7 +307,7 @@ function hello() {
 ```
 ````
 
-### Tables
+#### Tables
 
 ```
 | Header 1 | Header 2 | Header 3 |
@@ -328,7 +316,7 @@ function hello() {
 | Row 2    | Data     | Data     |
 ```
 
-### Horizontal rule
+#### Horizontal rule
 
 ```
 ---
@@ -338,21 +326,21 @@ or
 ___
 ```
 
-### Task lists
+#### Task lists
 
 ```
 - [x] Completed task
 - [ ] Incomplete task
 - [ ] Another task
 ```
 
-### Escaping characters
+#### Escaping characters
 
 ```
 Use backslash to escape: \* \_ \# \`
 ```
 
-### Line breaks
+#### Line breaks
 
 ```
 End a line with two spaces

docs/accessmap/index.md

@@ -4,18 +4,18 @@ title: AccessMap
 
 <!-- @format -->
 
-# AccessMap
+## AccessMap
 
 AccessMap ([https://accessmap.app](https://accessmap.app)) provides detailed information in select cities on pedestrian paths, transit stations, elevation changes, curb ramps, and more to enable accessibility-focused multimodal routing.
 
 ---
 
-## Guides
+### Guides
 
 AccessMap Guides
 
 _For a list of all guides on the TCAT Wiki, refer to the [Guides List](../guides-list/index.md)._
 
-### [AccessMap User Manual](user-manual/index.md)
+#### [AccessMap User Manual](user-manual/index.md)
 
 This user manual explains how to use the AccessMap application.

docs/accessmap/user-manual/index.md

@@ -8,7 +8,7 @@ tags:
 
 <!-- @format -->
 
-# AccessMap User Manual
+## AccessMap User Manual
 
 This user manual explains how to use the AccessMap application.
 

docs/aviv-scoutroute/index.md

@@ -4,28 +4,28 @@ title: AVIV ScoutRoute
 
 <!-- @format -->
 
-# AVIV ScoutRoute
+## AVIV ScoutRoute
 
 AVIV ScoutRoute ([GitHub](https://github.com/OpenSidewalks/GoInfoGame)), formerly "[GoInfoGame](https://tcat.cs.washington.edu/goinfogame-app/)" is a volunteerism app based on [StreetComplete](https://github.com/streetcomplete/StreetComplete) that leverages the power of crowdsourcing to gather critical pedestrian and accessibility information.
 
 ---
 
-## Guides
+### Guides
 
 AVIV ScoutRoute Guides
 
 _For a list of all guides on the TCAT Wiki, refer to the [Guides List](../guides-list/index.md)._
 
-### [AVIV ScoutRoute User Manual](user-manual/index.md)
+#### [AVIV ScoutRoute User Manual](user-manual/index.md)
 
 This user manual explains how to install and use the AVIV ScoutRoute mobile app.
 
-### [Long Form Quest Definition](quests/index.md) Guides
+#### [Long Form Quest Definition](quests/index.md) Guides
 
-#### [Element Query Guide](quests/element-query.md)
+##### [Element Query Guide](quests/element-query.md)
 
 This guide explains how to format the element query selector for use in an AVIV ScoutRoute Long Form Quest Definition.
 
-#### [Element Type Icon Guide](quests/element-type-icon.md)
+##### [Element Type Icon Guide](quests/element-type-icon.md)
 
 This guide explains how to assign the correct value for the `element_type_icon` key in the Long Form Quest Definition JSON file used by AVIV ScoutRoute.