Skip to content

Commit dcc518b

Browse files
Merge PR #7 from TaskarCenterAtUW/asr-user-manual
- Added AVIV ScoutRoute User Manual - Added TDEI Account Registration guide - Updated Contributing guide - Added new tags - Added images - Added abbreviations - Update utilities scripts
2 parents 14ae25e + 872f898 commit dcc518b

File tree

89 files changed

+1399
-1082
lines changed

Some content is hidden

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

89 files changed

+1399
-1082
lines changed

.cache/plugin/git-committers/page-authors.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

.cache/plugin/privacy/assets/external/unpkg.com/mermaid@11/dist/mermaid.min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/copilot-instructions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ tags:
7676
---
7777
```
7878

79+
**Tags**: Tags, restricted to the allowed tags listed in `mkdocs.yml`, are used for categorizing pages. The intended audience is tagged across two axes: Internal-vs-External and Developer-vs-User. Note that "External" implies that it is suitable for "Internal" audience as well, and that "User" implies that it is suitable for "Developer" audience as well. These are explicitly _not_ access restrictions; external users can access all content.
80+
7981
**Note**: The `" - Guide"` tag does not need to be added to guides, as that tag is inherited from the `.meta.yml` file in that directory.
8082

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

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.claude/
21
local-storage/
32
tcat-wiki.code-workspace
4-
CLAUDE.md
53
*.wip

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- @format -->
2+
13
# TCAT Wiki
24

35
This repository contains the files used to create the [TCAT Wiki](https://taskarcenteratuw.github.io/tcat-wiki/) using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

docs/about/guides/CONTRIBUTING.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
---
22
title: Contributing
3+
tags:
4+
- Internal
5+
- Developer
36
---
47

58
<!-- @format -->
@@ -33,7 +36,9 @@ This section of the guide explains how to set up a Windows environment for contr
3336
1. Install [Visual Studio Code](https://code.visualstudio.com/)
3437

3538
1. Install [YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) plugin
39+
3640
2. Install [Markdown All in One](https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one) plugin
41+
3742
3. Install [EditorConfig for VS Code](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)
3843

3944
2. Install mkdocs-material
@@ -82,7 +87,19 @@ This section of the guide explains how to set up a Windows environment for contr
8287

8388
Refer to the documentation for [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and the [MkDocs User Guide](https://www.mkdocs.org/user-guide/).
8489

85-
### Screenshots
90+
### Images
91+
92+
Where possible, follow these guidelines for images:
93+
94+
1. Format: 24-bit `.png`
95+
96+
2. Resizing: Scale images using `{ width="123" }`:
97+
98+
`![alt text](image.png){ width="300" }`
99+
100+
Refer to [Material for MkDocs: Images](https://squidfunk.github.io/mkdocs-material/reference/images/) and [Material for MkDocs: Attribute Lists](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists) for more information.
101+
102+
#### Screenshots
86103

87104
For creating screenshots with a consistent style, Firefox DevTools is to be used.
88105

@@ -114,7 +131,44 @@ For creating screenshots with a consistent style, Firefox DevTools is to be used
114131

115132
4. Resulting screenshots will fit exactly within the 2px outside border present in the following screenshot templates:
116133

117-
1. [Screenshot (Landscape)](../../../resources/images/template/screenshot-landscape.png)
118-
2. [Screenshot (Portrait)](../../../resources/images/template/screenshot-portrait.png)
134+
1. [Screenshot (Landscape)](../../resources/images/template/screenshot-landscape.png)
135+
136+
2. [Screenshot (Portrait)](../../resources/images/template/screenshot-portrait.png)
137+
138+
5. It is recommended to remove all embedded metadata, such as with the use of [ExifToolGUI](https://exiftool.org/gui/).
139+
140+
#### Image Annotations
141+
142+
For creating image annotations with a consistent style, follow these guidelines.
143+
144+
1. Highlight box
145+
146+
2. Use: Indicating an area of focus in an image.
147+
148+
3. Style
149+
150+
1. Padding: `2px` distance from highlighted selection
151+
152+
2. Outline
153+
154+
1. Width: `1px`
155+
156+
2. Color: `#4B2E83` ("Husky "Purple")
157+
158+
3. Fill
159+
160+
1. Color: `#FFC700` ("Spirit Gold")
161+
162+
2. Opacity: `0.25`
163+
164+
4. Example:
165+
166+
![alt text](../../resources/images/tdei-portal/login-h-forgot-password.png){ loading=lazy }
167+
168+
5. Naming convention: For images with highlights, append `-h-$highlightedFeature`
169+
170+
1. Example: `login.png``login-h-forgot-password.png`
171+
172+
#### QR Codes
119173

120-
5. It is recommended to remove embedded metadata, such as with the use of [ExifToolGUI](https://exiftool.org/gui/).
174+
1. Create QR codes using [Project Nayuki's QR Code generator library](https://github.com/nayuki/QR-Code-generator).

docs/about/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: About
33
---
44

5+
<!-- @format -->
6+
57
# About
68

79
The TCAT Wiki is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- @format -->
2+
13
<!-- ---
24
Note: `title` is not defined for this page so that the title "TCAT Wiki" is output instead of "TCAT Wiki - TCAT Wiki"
35
title: TCAT Wiki

0 commit comments

Comments
 (0)