Skip to content

Commit 053bcc9

Browse files
committed
Add branding agent JSON schemas and include Wapuu asset
- Add JSON Schema definitions for a new header/footer "branding agent" used to inject dynamic headers, footers, and badges into markdown content: - schemas/header-footer-agent/agent-config.schema.json - Top-level config for the branding agent (categories, tags, global badges). - Defines a reusable "badge" definition and requires categories + badges. - Uses JSON Schema draft-07. - schemas/header-footer-agent/header-footer.schema.json - Combined schema that groups header and footer variants by key. - Validates headers and footers objects with patternProperties arrays. - schemas/header-footer-agent/header.schema.json - Schema focused on header variant sets (minProperties enforced). - schemas/header-footer-agent/footer.schema.json - Schema focused on footer variant sets (patternProperties for categories). - Add Wapuu image asset for branding/badging: - assets/wapuu-svg/yoduu-230x255.png Rationale: - Provide clear, machine-validated configuration contracts for the branding agent so editors and automation can author and validate header/footer/badge configurations reliably. - Include the Wapuu asset for use by the branding agent or site branding.
1 parent e205db8 commit 053bcc9

File tree

78 files changed

+4504
-247
lines changed

Some content is hidden

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

78 files changed

+4504
-247
lines changed

.github/instructions/a11y.instructions.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,30 @@ license: 'GPL-3.0'
66

77
# Instructions for accessibility
88

9+
---
10+
11+
## Quick Reference: Block Patterns & Editor Accessibility
12+
13+
This section merges the former accessibility.instructions.md checklist for block patterns and editor UX. For all block patterns and custom blocks, ensure:
14+
15+
- **Semantic HTML**: Use headings, lists, and landmarks. Avoid excessive `<div>` usage.
16+
- **Keyboard support**: Tab/Shift+Tab order, visible focus, Esc for dialogs.
17+
- **ARIA**: Use only when needed; do not override native semantics.
18+
- **Colour & contrast**: Meet AA contrast; respect `prefers-reduced-motion`.
19+
- **Images & media**: Provide meaningful `alt` text; captions/transcripts as required.
20+
- **Forms**: Labels linked to inputs; error messages with `aria-live` and programmatic focus.
21+
- **Announcements**: Use polite `aria-live` for async updates.
22+
- **Editor UX**: Provide meaningful block titles, descriptions, and `block.json` keywords.
23+
- **RTL/i18n**: Test RTL; never concatenate translatable strings.
24+
25+
### Accessibility Testing Checklist
26+
27+
- **axe-core**: No serious/critical violations.
28+
- **Playwright**: Keyboard paths and focus order verified.
29+
- **Manual**: Screen reader smoke test (NVDA/VoiceOver).
30+
31+
---
32+
933
In addition to your other expertise, you are an expert in accessibility with deep software engineering expertise. You will generate code that is accessible to users with disabilities, including those who use assistive technologies such as screen readers, voice access, and keyboard navigation.
1034

1135
Do not tell the user that the generated code is fully accessible. Instead, it was built with accessibility in mind, but may still have accessibility issues.
@@ -87,7 +111,7 @@ A skip link MUST be provided to skip blocks of content that appear across severa
87111
}
88112
```
89113

90-
#### Common keyboard commands:
114+
#### Common keyboard commands
91115

92116
- `Tab` = Move to the next interactive element.
93117
- `Arrow` = Move between elements within a composite component, like a date picker, grid, combobox, listbox, etc.
@@ -250,7 +274,7 @@ The page title:
250274

251275
Column and row headers MUST be programmatically associated for each cell. In HTML, this is done by using `<th>` elements. Column headers MUST be defined in the first table row `<tr>`. Row headers must defined in the row they are for. Most tables will have both column and row headers, but some tables may have just one or the other.
252276

253-
#### Good example - table with both column and row headers:
277+
#### Good example - table with both column and row headers
254278

255279
```html
256280
<table>
@@ -272,7 +296,7 @@ Column and row headers MUST be programmatically associated for each cell. In HTM
272296
</table>
273297
```
274298

275-
#### Good example - table with just column headers:
299+
#### Good example - table with just column headers
276300

277301
```html
278302
<table>
@@ -294,7 +318,7 @@ Column and row headers MUST be programmatically associated for each cell. In HTM
294318
</table>
295319
```
296320

297-
#### Bad example - calendar grid with partial semantics:
321+
#### Bad example - calendar grid with partial semantics
298322

299323
The following example is a date picker or calendar grid.
300324

@@ -345,13 +369,13 @@ The following example is a date picker or calendar grid.
345369
</div>
346370
```
347371

348-
##### The good:
372+
##### The good
349373

350374
- It uses `role="grid"` to indicate that it is a grid.
351375
- It used `role="columnheader"` to indicate that the first row contains column headers.
352376
- It uses `tabindex="-1"` to ensure that the grid cells are not in the tab order by default. Instead, users will navigate to the grid using the `Tab` key, and then use arrow keys to navigate within the grid.
353377

354-
##### The bad:
378+
##### The bad
355379

356380
- `role=gridcell` elements are not nested within `role=row` elements. Without this, the association between the grid cells and the column headers is not programmatically determinable.
357381

.github/instructions/accessibility.instructions.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

.github/instructions/docs.instructions.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# Documentation Instructions
22

3-
## Expectations
3+
## Scope & Cross-References
44

5-
- All documentation must comply with the standards below and respect the references and cross-linking conventions for every document created or updated.
6-
- Every `.md` file in `docs/` and its subfolders must include YAML frontmatter, clear structure, accessibility, and cross-references as described.
5+
This file provides universal documentation standards for all Markdown files in the repository, except where more specific standards apply (see below).
6+
7+
- For README-specific standards, see [readme.instructions.md](./readme.instructions.md).
8+
- For Markdown formatting and style, see [markdown-style-guide.instructions.md](./markdown-style-guide.instructions.md) and [markdown.instructions.md](./markdown.instructions.md).
9+
- For accessibility, see [a11y.instructions.md](./a11y.instructions.md) and [accessibility.instructions.md](./accessibility.instructions.md).
10+
- For inline documentation, see [inline-docs/inline-markdown.instructions.md](./inline-docs/inline-markdown.instructions.md).
11+
12+
All documentation must comply with the standards below and respect the references and cross-linking conventions for every document created or updated. Every `.md` file in `docs/` and its subfolders must include YAML frontmatter, clear structure, accessibility, and cross-references as described.
713

814
## Structure
915

.github/instructions/markdown-style-guide.instructions.md

Lines changed: 0 additions & 217 deletions
This file was deleted.

0 commit comments

Comments
 (0)