Skip to content

Commit 6f70ffc

Browse files
ExperimentsInHonestyExperimentsInHonesty
authored
Create index.md
1 parent ed1d164 commit 6f70ffc

1 file changed

Lines changed: 166 additions & 0 deletions

File tree

‎docs/templates/index.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
This page is the home for issue and wiki templates.
2+
3+
## Known Issues Wiki Page Template
4+
The wiki pages created from this template will be used for future audits (across many teams) so that volunteers can easily identify and refer to technical solutions to WAVE accessibility errors.
5+
6+
### Instructions
7+
1. Replace all bracketed `[placeholders]` with actual content
8+
2. Update the date in `YYYY-MM-DD` format
9+
3. Fill in the WAVE Tool Reference section with content from the official WAVE documentation
10+
4. Provide specific details in the Project Team Solution section based on your issue and PR
11+
5. Add actual screenshot URLs to replace `IMAGE_URL` placeholders
12+
6. Add all contributor GitHub handles in the Credits section (wiki page author, PR author and reviewers)
13+
7. Remove or add screenshot sections as needed
14+
15+
### Wiki Page Template
16+
17+
Copy/paste this template into the new wiki page editor:
18+
19+
<details><summary>Title</summary>
20+
21+
```
22+
[REPLACE WITH WAVE CATEGORY]-[REPLACE WITH WAVE ERROR NAME]
23+
```
24+
</details>
25+
26+
<details><summary>Body</summary>
27+
28+
````
29+
# WAVE Known Accessibility Issue: [REPLACE WITH WAVE CATEGORY] - [REPLACE WITH WAVE ERROR NAME]
30+
- WAVE Category: [REPLACE WITH WAVE CATEGORY]
31+
- WAVE Error: [REPLACE WITH WAVE ERROR NAME]
32+
33+
## Page Content Status
34+
- [ ] WAVE Error guidance text
35+
- [ ] Example of a DOM Snippet Generated From WAVE Tool
36+
- Project Team Error guidance
37+
- [ ] Project Team Page Details
38+
- [ ] Project Team Issue and PR details
39+
- [ ] Project Team Solution
40+
- [ ] Credits/Authors
41+
42+
## WAVE Error guidance
43+
44+
WAVE Tool's Reference material on [REPLACE WITH WAVE ERROR NAME] may not specifically address your problem. We provide it here for optional reading.
45+
46+
<details><summary>Click to see WAVE Tool Reference</summary>
47+
48+
<!-- Note For Wiki Author: WAVE Tool text content will use text that break markdown generation for the details dropdown. If the copy/pasted text includes angle brackets, surround them with backticks to avoid this problem. -->
49+
50+
### WAVE Category
51+
[REPLACE WITH WAVE CATEGORY]
52+
53+
### WAVE Error
54+
[REPLACE WITH WAVE ERROR NAME]
55+
56+
### What It Means
57+
[REPLACE WITH WAVE CONTENT FOR What It Means]
58+
59+
### Why It Matters
60+
[REPLACE WITH WAVE CONTENT FOR Why It Matters]
61+
62+
### What To Do
63+
[REPLACE WITH WAVE CONTENT FOR What To Do]
64+
65+
### The Algorithm... in English
66+
[REPLACE WITH WAVE CONTENT FOR The Algorithm... In English]
67+
68+
### Standards and Guidelines
69+
[REPLACE WITH WAVE CONTENT FOR Standards and Guidelines]
70+
71+
</details>
72+
73+
## Example of a DOM Snippet Generated From WAVE Tool
74+
75+
> ```html
76+
> [HTML snippet showing the problematic code structure that WAVE detected]
77+
> ```
78+
79+
80+
## Project Team Error guidance
81+
82+
The following material covers how the Project Team has provided a solution to the [Error] WAVE error.
83+
84+
### Project Page Details
85+
- Project Page name: [INSERT PAGE NAME or "ALL"]
86+
- Project Staging URL: [INSERT URL or "N/A"]
87+
- Requires sign in: [TRUE OR FALSE]
88+
- Required User Role: [INSERT ONE OF: Visitor, Logged in user, Admin, Security Admin]
89+
- Can access page directly from URL: [TRUE OR FALSE]
90+
- Accepts URL parameters: [TRUE OR FALSE]
91+
92+
### Project Team Issue and PR details
93+
- Related GitHub Issue(s):
94+
- [INSERT ISSUE URL]
95+
- Related Pull Request(s):
96+
- [INSERT PR URL]
97+
- React Component(s)
98+
- [INSERT PATH: e.g. path/to/Component.jsx]
99+
100+
### Project Team Solution
101+
102+
#### What is the specific problem that was occurring?
103+
<!-- Author Instructions: Add a detailed explanation of the specific accessibility problem, including context about when/where it occurs, what elements are involved, and why it's problematic for assistive technology users -->
104+
[INSERT CONTENT]
105+
106+
#### What is the proposed solution to this problem?
107+
<!-- Author Instructions: Add a few sentences describing the fix. "Why the Fix Works" comes later (see below). If there are lots of instructions required to explain the solution, include them in Developer Resources below -->
108+
[INSERT CONTENT]
109+
110+
#### Step-By-Step Guide
111+
<!-- Author Instructions: Replace details dropdown with N/A if this does not apply -->
112+
113+
<details><summary>Click to see step-by-step guide</summary>
114+
115+
[ADD DETAILED INSTRUCTIONS HERE]
116+
117+
</details>
118+
119+
#### Other Technical Details
120+
<!-- Author Instructions: Write N/A if this does not apply -->
121+
122+
<details><summary>Click to see other technical details</summary>
123+
124+
[ INSERT OTHER DETAILS e.g. Prop References, Return Value ]
125+
126+
</details>
127+
128+
#### Code Snippet With Solution
129+
<details><summary>Click to see code snippets...</summary>
130+
131+
[INSERT PATH file/path/to/Snippet.jsx]
132+
133+
```jsx
134+
[Code example showing the fix/solution]
135+
```
136+
137+
</details>
138+
139+
#### Why the Fix Works
140+
<!-- Author Instruction: Add an explanation of how the code changes resolve the accessibility issue and why this approach was chosen -->
141+
[INSERT CONTENT]
142+
143+
#### Where this solution is applicable
144+
<!-- Author Instruction: Add a bullet point list of scenarios that might trigger this error and would be fixed by applying the provided solution, e.g. particular groupings of html elements, user interactivity, code-specific edge cases -->
145+
- [INSERT SCENARIO 1]
146+
- [INSERT SCENARIO 2]
147+
- [INSERT SCENARIO N]
148+
149+
#### Screenshots of WAVE Error
150+
151+
<!-- Author Instructions: when including markdown images, ensure they are responsive by specifying EITHER width OR height. Do not provide both. -->
152+
153+
<details><summary>1. [Descriptive Title for Screenshot Set 1]</summary>
154+
155+
<img width="400" alt="Image" src="https://github.com/user-attachments/assets/123456789" />
156+
157+
</details>
158+
159+
## Credits/Authors
160+
<!-- Author Instructions: Add bullet points with GitHub handles of all HfLA members who contributed to this wiki page and/or contributed to Pull Requests that provided solutions for this page -->
161+
- [INCLUDE Contributor 1]
162+
- [INCLUDE Contributor 2]
163+
- [INCLUDE Contributor N]
164+
165+
````
166+
</details>

0 commit comments

Comments
 (0)