Skip to content

Add daily Primer-styled documentation diagram workflow - #54873

Merged
pelikhan merged 4 commits into
mainfrom
copilot/task-9919-1036865607-696dced5-ed7b-4c9c-818c-e42c5065b169
Aug 22, 2026
Merged

Add daily Primer-styled documentation diagram workflow#54873
pelikhan merged 4 commits into
mainfrom
copilot/task-9919-1036865607-696dced5-ed7b-4c9c-818c-e42c5065b169

Conversation

Copilot AI commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

Adds a daily workflow that cycles through documentation pages, generates a focused diagram, and opens a pre-created draft PR. Diagrams use diagram-design guidance while matching GitHub Primer visual and accessibility standards.

  • Scheduling and state

    • Daily schedule plus manual dispatch.
    • drive-memory persists round-robin page selection.

  • Diagram generation

    • Pins cathrynlavery/diagram-design to a commit.
    • Produces self-contained, accessible SVG assets using Primer colors, typography, and minimal visual treatment.
    • Links each diagram into its selected MDX page.

  • PR guardrails

    • Uses pre-created draft PRs.
    • Restricts changes to one documentation page and one SVG asset.
    • Requires documentation build success; otherwise emits noop.
safe-outputs:
  create-pull-request:
    pre-create: true
    draft: true
    allowed-files:
      - "docs/src/content/docs/**/*.mdx"
      - "docs/src/assets/diagrams/**/*.svg"

Copilot AI and others added 2 commits August 22, 2026 16:07
@pelikhan
Plan daily documentation diagram workflow
e63dce9 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan
Add daily documentation diagram workflow
d101226 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan

pelikhan commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

@copilot use cache-memory instead of drive-memory

@pelikhan
Use cache memory for documentation diagrams
a79bccc 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI commented Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

@copilot use cache-memory instead of drive-memory

Updated in a79bccc. The workflow now uses 30-day cache-memory and persists its round-robin state at /tmp/gh-aw/cache-memory/state.json.

Copilot AI requested a review from pelikhan August 22, 2026 17:40
@pelikhan

pelikhan commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

@copilot use the skills front matter field to install skills from https://github.com/cathrynlavery/diagram-design.git

@pelikhan
Install diagram design workflow skill
6119c9c 
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI commented Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

@copilot use the skills front matter field to install skills from https://github.com/cathrynlavery/diagram-design.git

Implemented in 6119c9c. The workflow now installs the pinned diagram-design skill through skills front matter.

@pelikhan
pelikhan marked this pull request as ready for review August 22, 2026 18:02
Copilot AI balanced review requested due to automatic review settings August 22, 2026 18:02
@pelikhan
pelikhan merged commit 1352fdd into main Aug 22, 2026
@pelikhan
pelikhan deleted the copilot/task-9919-1036865607-696dced5-ed7b-4c9c-818c-e42c5065b169 branch August 22, 2026 18:02
Copilot AI reviewed Aug 22, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a scheduled workflow for generating Primer-styled documentation diagrams.

Changes:

  • Adds round-robin document selection with persisted state.
  • Generates accessible SVGs and constrained draft PRs.
  • Regenerates workflow locks, unintentionally disabling strict mode in existing workflows.
Show a summary per file
File Description
daily-documentation-diagram.md Defines diagram generation workflow.
daily-documentation-diagram.lock.yml Compiled workflow output.
mcp-inspector.lock.yml Disables prior strict compilation.
gpclean.lock.yml Disables prior strict compilation.
example-permissions-warning.lock.yml Disables prior strict compilation.
dev.lock.yml Disables prior strict compilation.
daily-team-evolution-insights.lock.yml Disables prior strict compilation.
copilot-pr-merged-report.lock.yml Disables prior strict compilation.
cli-version-checker.lock.yml Disables prior strict compilation.
cli-consistency-checker.lock.yml Disables prior strict compilation.
blog-auditor.lock.yml Disables prior strict compilation.
ace-editor.lock.yml Disables prior strict compilation.

Review details

  • Files reviewed: 11/12 changed files
  • Comments generated: 12
  • Review effort level: Balanced

Comment thread .github/workflows/mcp-inspector.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e0997d32f92614ebb3575495f8e36f304de2c7421545a79f0cfab26c5891380a","body_hash":"42daae928c8295891472e702ddec1ad8479ca526a291e5a9db7f7f89037a8b94","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.80","copilot-sdk":"1.0.11"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e0997d32f92614ebb3575495f8e36f304de2c7421545a79f0cfab26c5891380a","body_hash":"42daae928c8295891472e702ddec1ad8479ca526a291e5a9db7f7f89037a8b94","agent_id":"copilot","engine_versions":{"copilot":"1.0.80","copilot-sdk":"1.0.11"}}
Comment thread .github/workflows/gpclean.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e4c3e81303647b24ae34d57155b8443abb752d176842d02cd3b3479853406b02","body_hash":"9a319e8c129ca199af41fd0816dc41f10994ae38a6a37c2c2cf0a82f9d9ebf54","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"e4c3e81303647b24ae34d57155b8443abb752d176842d02cd3b3479853406b02","body_hash":"9a319e8c129ca199af41fd0816dc41f10994ae38a6a37c2c2cf0a82f9d9ebf54","agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
Comment thread .github/workflows/example-permissions-warning.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"3081a53a364f2fe6eda3086c877ca6046d453e0092c0eb1374703ffd56ece777","body_hash":"e1998198345ea79225db083490d051afef427544d6528377b8556a3cb4638d22","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"3081a53a364f2fe6eda3086c877ca6046d453e0092c0eb1374703ffd56ece777","body_hash":"e1998198345ea79225db083490d051afef427544d6528377b8556a3cb4638d22","agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
Comment thread .github/workflows/dev.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"9ea4a7e6f815b72e623c13c8c0d8840935f80821a068d5cf412cae622c611d58","body_hash":"8a03ac2d1f92d6410a68f2e84d24acc9baa720ebd5309d2732f5da0239339f83","strict":true,"agent_id":"codex","agent_model":"gpt-5.4","engine_versions":{"codex":"0.148.0"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"9ea4a7e6f815b72e623c13c8c0d8840935f80821a068d5cf412cae622c611d58","body_hash":"8a03ac2d1f92d6410a68f2e84d24acc9baa720ebd5309d2732f5da0239339f83","agent_id":"codex","agent_model":"gpt-5.4","engine_versions":{"codex":"0.148.0"}}
Comment thread .github/workflows/daily-team-evolution-insights.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"2d0f779aaf8f7164d73363bd00b226c0ffb9138298fa71e22f4d4f95107f0bf0","body_hash":"1572e54b8a5340cd1eca0454a579e520b856fac10d8826f3eadd3cc63d1fb376","strict":true,"agent_id":"goose","agent_model":"copilot/claude-sonnet-4.5","engine_versions":{"goose":"1.45.0"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"2d0f779aaf8f7164d73363bd00b226c0ffb9138298fa71e22f4d4f95107f0bf0","body_hash":"1572e54b8a5340cd1eca0454a579e520b856fac10d8826f3eadd3cc63d1fb376","agent_id":"goose","agent_model":"copilot/claude-sonnet-4.5","engine_versions":{"goose":"1.45.0"}}
Comment thread .github/workflows/cli-consistency-checker.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"5622d03f61e8ab47358e2caf9339fb0678da4593b665b7c6e8bafbbc09229a0c","body_hash":"c3e994dad61c9d825aa7f7c1b745793e15d10fd48c2ccc419e3b15d819c2b430","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.80","copilot-sdk":"1.0.11"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"5622d03f61e8ab47358e2caf9339fb0678da4593b665b7c6e8bafbbc09229a0c","body_hash":"c3e994dad61c9d825aa7f7c1b745793e15d10fd48c2ccc419e3b15d819c2b430","agent_id":"copilot","engine_versions":{"copilot":"1.0.80","copilot-sdk":"1.0.11"}}
Comment thread .github/workflows/blog-auditor.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"867031d54f72663135c068879eb9696cce12d8c0b079bbbbf11b14df59b91bc4","body_hash":"c218bd9f70b366d3252594a8ad1ba62bea5be8799b839bf6ac1b55840af391fe","strict":true,"agent_id":"claude","engine_versions":{"claude":"2.1.237"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"867031d54f72663135c068879eb9696cce12d8c0b079bbbbf11b14df59b91bc4","body_hash":"c218bd9f70b366d3252594a8ad1ba62bea5be8799b839bf6ac1b55840af391fe","agent_id":"claude","engine_versions":{"claude":"2.1.237"}}
Comment thread .github/workflows/ace-editor.lock.yml
@@ -1,4 +1,4 @@
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"be57566a84f0e8ad718579e92de26e7263b7e450fec93a61c1a3813cfbef56df","body_hash":"30d40738b32791caae633af85d6d2bb8aac971f646c1bab499220afd3c17b8a2","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"be57566a84f0e8ad718579e92de26e7263b7e450fec93a61c1a3813cfbef56df","body_hash":"30d40738b32791caae633af85d6d2bb8aac971f646c1bab499220afd3c17b8a2","agent_id":"copilot","engine_versions":{"copilot":"1.0.80"}}
Comment thread .github/workflows/daily-documentation-diagram.md
## Validate and publish

1. Confirm the patch contains only the selected MDX page and the new SVG. Confirm the SVG has a `viewBox`, accessibility metadata, no `<script>` element, and no external URL.
2. Run `npm run build` from `docs/`. Revert the diagram and page change if the build fails.
Comment thread .github/workflows/daily-documentation-diagram.md
- foreground `#1f2328`, muted text `#59636e`, border `#d0d7de`
- use `#0969da` only for the one focal relationship or action
- use a system/Mona Sans-compatible font stack, 1px rules, square or minimally rounded corners, and no shadows or gradients
5. Make the SVG accessible: include `role="img"`, a unique `aria-labelledby`, and first-child `<title>` and `<desc>` elements. Use concise, readable labels and preserve sufficient contrast.
@github-actions

github-actions Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.87.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Balanced
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@pelikhan pelikhan Awaiting requested review from pelikhan

Assignees

@pelikhan pelikhan

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pelikhan