Skip to content

Commit 58bfb5c

Browse files
authored
Update index.md
1 parent 35a6cc6 commit 58bfb5c

1 file changed

Lines changed: 13 additions & 7 deletions

File tree

docs/wiki-and-issue-templates/index.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,18 @@ The wiki pages created from this template will be used for future audits (across
77

88
### Instructions
99
1. Replace all bracketed `[placeholders]` with actual content
10-
2. Update the date in `YYYY-MM-DD` format
11-
3. Fill in the WAVE Tool Reference section with content from the official WAVE documentation
12-
4. Provide specific details in the Project Team Solution section based on your issue and PR
13-
5. Add actual screenshot URLs to replace `IMAGE_URL` placeholders
14-
6. Add all contributor GitHub handles in the Credits section (wiki page author, PR author and reviewers)
15-
7. Remove or add screenshot sections as needed
10+
1. Update the date in `YYYY-MM-DD` format
11+
1. Fill in the area below "Click to see WAVE Tool Reference" with content from the official WAVE documentation
12+
1. Go to https://wave.webaim.org/api/docs?format=html
13+
1. Find the section that matches the WAVE guidance referenced in this file
14+
1. Copy the anchor name from the URL (the part after `#`)
15+
1. Replace both [REPLACE ANCHOR NAME] in the link with that anchor name
16+
1. Replace [YYYY-MM-DD] with the date the content was added or reviewed
17+
1. For each header under that (e.g. ### WAVE Category), add the content from the relevant WAVE guidance section
18+
1. Provide specific details in the Project Team Solution section based on your issue and PR
19+
1. Add actual screenshot URLs to replace `IMAGE_URL` placeholders
20+
1. Add all contributor GitHub handles in the Credits section (wiki page author, PR author and reviewers)
21+
1. Remove or add screenshot sections as needed
1622

1723
### Template
1824
Copy/paste this template to create a wiki page in the folder: /known-issues-and-solutions/solutions-index
@@ -41,7 +47,7 @@ The filename should be all lowercase and without brackets
4147
- [ ] Project Team Solution
4248
- [ ] Credits/Authors
4349
44-
## WAVE Error guidance
50+
## WAVE Guidance
4551
4652
WAVE Tool's Reference material on [REPLACE WITH WAVE ERROR NAME] may not specifically address your problem. We provide it here for optional reading.
4753

0 commit comments

Comments
 (0)