Skip to content

Commit 2aea41c

Browse files
docs: add branding conventions to scaffolding agent/instructions/skill
- agent: Add branding copy + favicon + logo header steps (steps 8-10) - instructions: Add Branding Conventions section with asset table and templates - skill: Fix head_custom.html filename, add favicon files to workshop tree Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 094fa39 commit 2aea41c

3 files changed

Lines changed: 52 additions & 4 deletions

File tree

agents/domain-scaffolder.agent.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,10 @@ Generate the complete `{domain}-scan-workshop` repository structure following th
9797
5. Create `.devcontainer/` with `devcontainer.json` and `post-create.sh`.
9898
6. Create Jekyll site files (`_config.yml`, `index.md`, `Gemfile`) using the Just the Docs theme templates from the scaffolding skill. The `_config.yml` MUST use `remote_theme: just-the-docs/just-the-docs` with `heading_anchors: true` and appropriate `exclude` list. The `index.md` MUST have `layout: default`, `title: Home`, `nav_order: 0`, and `permalink: /`.
9999
7. Create `CONTRIBUTING.md` and `README.md`.
100-
8. Generate `_includes/head_custom.html` with Mermaid v11 ESM support using the Mermaid support template from the scaffolding skill.
101-
9. Auto-generate screenshot `![image](../images/lab-NN/filename.png)` references in all lab markdown files, placing them after each step that produces visible output.
100+
8. Generate `_includes/head_custom.html` with Mermaid v11 ESM support AND favicon links using the Mermaid support template from the scaffolding skill. Include `<link>` tags for `favicon.ico`, `favicon-32x32.png`, and `apple-touch-icon.png` from `assets/branding/`.
101+
9. Copy branding assets (`logo-128.png`, `favicon.ico`, `favicon-32x32.png`, `apple-touch-icon.png`) from the framework `assets/branding/` directory to `assets/branding/` in both the scanner and workshop repos.
102+
10. Add a centered logo header (`logo-128.png`) at the top of the workshop `index.md` and the scanner `README.md` using the README Header Template from the scaffolding skill.
103+
11. Auto-generate screenshot `![image](../images/lab-NN/filename.png)` references in all lab markdown files, placing them after each step that produces visible output.
102104
10. Include a working directory callout block in labs that reference files from the demo-app repository. Use a blockquote format: `> **Working Directory**: Run the following commands from the `{domain}-scan-demo-app` repository root.`
103105
11. Generate lab YAML frontmatter with `permalink`, `title`, and `description` fields, plus a metadata table (Duration, Level, Prerequisites) immediately after the heading. Just the Docs generates sidebar navigation automatically from page `title` fields — no `parent`, `nav_order`, or `has_children` properties are needed for labs.
104106
12. Add `nav_exclude: true` frontmatter to ALL screenshot inventory pages (`images/lab-NN/README.md`) so they do not appear in the sidebar navigation. Only labs and the home page should appear in the sidebar.

instructions/domain-scaffolding.instructions.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -757,6 +757,49 @@ Workshop repositories MUST support Mermaid diagrams in lab markdown rendered via
757757
3. Use the Mermaid support template from the scaffolding skill.
758758
4. Labs MAY use fenced code blocks with `mermaid` language identifier for architecture diagrams, flow charts, and sequence diagrams.
759759

760+
## Branding Conventions
761+
762+
All scaffolded repositories MUST include framework branding for visual consistency across the ecosystem.
763+
764+
### Branding Assets to Copy
765+
766+
Copy from the framework repo `assets/branding/` to each generated repository's `assets/branding/`:
767+
768+
| Asset | Source Path | Target Repos |
769+
|-------|-----------|--------------|
770+
| `logo-128.png` | `logo/logo-128.png` | Scanner + Workshop |
771+
| `favicon.ico` | `favicon/favicon.ico` | Workshop only |
772+
| `favicon-32x32.png` | `favicon/favicon-32x32.png` | Workshop only |
773+
| `apple-touch-icon.png` | `favicon/apple-touch-icon.png` | Workshop only |
774+
775+
### README Logo Header
776+
777+
Both scanner and workshop READMEs MUST include a centered logo at the top:
778+
779+
```markdown
780+
<p align="center">
781+
<img src="assets/branding/logo-128.png" alt="Agentic Accelerator Framework" width="100">
782+
</p>
783+
```
784+
785+
### Workshop index.md Logo
786+
787+
The workshop `index.md` landing page MUST include the same centered logo between the YAML frontmatter and the H1 heading.
788+
789+
### Workshop Favicon Links
790+
791+
The workshop `_includes/head_custom.html` MUST include favicon links before the Mermaid script:
792+
793+
```html
794+
<link rel="icon" type="image/x-icon" href="{{ site.baseurl }}/assets/branding/favicon.ico">
795+
<link rel="icon" type="image/png" sizes="32x32" href="{{ site.baseurl }}/assets/branding/favicon-32x32.png">
796+
<link rel="apple-touch-icon" sizes="180x180" href="{{ site.baseurl }}/assets/branding/apple-touch-icon.png">
797+
```
798+
799+
### Social Preview (Manual Step)
800+
801+
Each generated repository SHOULD have its social preview set to `social-preview-1280x640.png` via Settings → General → Social preview. Document this as a manual next step in the scaffolding summary.
802+
760803
## Playwright Authentication State
761804

762805
Workshop screenshot manifests reference `github-auth.json` and `ado-auth.json` for authenticated page captures (Phase 3 and Phase 4 screenshots). These auth state files MUST be bootstrapped before running the capture script.

skills/domain-scaffolding/SKILL.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,10 @@ The following directory tree is the canonical structure for any `{domain}-scan-w
201201
│ └── full-day.md # 7h delivery guide
202202
├── assets/
203203
│ └── branding/
204-
│ └── logo-128.png # Framework logo for workshop header
204+
│ ├── logo-128.png # Framework logo for workshop header
205+
│ ├── favicon.ico # Browser tab icon
206+
│ ├── favicon-32x32.png # Web favicon
207+
│ └── apple-touch-icon.png # iOS bookmarks icon
205208
├── CONTRIBUTING.md # Workshop contribution guide
206209
└── README.md
207210
```
@@ -1341,7 +1344,7 @@ Every generated repository MUST include the framework logo in these locations:
13411344

13421345
2. **GitHub social preview** — Set via `gh repo edit --social-preview assets/branding/social/social-preview-1280x640.png` or upload manually in repo Settings → General → Social preview. The social preview image is stored in the framework repo and should be copied to each generated repo.
13431346

1344-
3. **Workshop `_includes/head-custom.html`** — Include favicon link alongside the Mermaid script:
1347+
3. **Workshop `_includes/head_custom.html`** — Include favicon link alongside the Mermaid script:
13451348

13461349
```html
13471350
<link rel="icon" type="image/x-icon" href="{{ site.baseurl }}/assets/branding/favicon.ico">

0 commit comments

Comments
 (0)