Skip to content

docs: add component spec skill#8179

Draft
joshblack wants to merge 14 commits into
mainfrom
docs/add-component-spec-skill
Draft

docs: add component spec skill#8179
joshblack wants to merge 14 commits into
mainfrom
docs/add-component-spec-skill

Conversation

@joshblack

Copy link
Copy Markdown
Member

Closes #

Changelog

New

Changed

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

@github-actions github-actions Bot added staff Author is a staff member integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Jul 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Action required

👋 Hi, this pull request contains changes to the source code that github/github-ui depends on. If you are GitHub staff, test these changes with github/github-ui using the integration workflow. If this doesn't work, you can also use the original workflow here. Check the integration testing docs for step-by-step instructions. Or, apply the integration-tests: skipped manually label to skip these checks.

To publish a canary release for integration testing, apply the Canary Release label to this PR.

Comment thread packages/spec/src/parser.ts Fixed
@changeset-bot

changeset-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1fabe42

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@primer/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@joshblack joshblack added the skip changeset This change does not need a changelog label Jul 16, 2026
…racter sanitization'

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@primer

primer Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

🤖 Lint issues have been automatically fixed and committed to this PR.

@github-actions
github-actions Bot temporarily deployed to storybook-preview-8179 July 16, 2026 22:12 Inactive
@primer

primer Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

🤖 Lint issues have been automatically fixed and committed to this PR.

@primer

primer Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

🤖 Lint issues have been automatically fixed and committed to this PR.

@primer

primer Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

🤖 Lint issues have been automatically fixed and committed to this PR.

@github-actions
github-actions Bot requested a deployment to storybook-preview-8179 July 17, 2026 03:17 Abandoned

@joshblack joshblack left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@copilot update the spec skill so that markup examples include basic HTML markup in the spec. it shouldn't just refer to it, html code blocks should live in there. Also make sure playground and default stories do not reference the spec (and correct any that do)

@joshblack joshblack added the integration-tests: skipped manually Changes in this PR do not require an integration test label Jul 20, 2026
…ault/playground stories

Co-authored-by: joshblack <3901764+joshblack@users.noreply.github.com>

Copilot AI commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

@copilot update the spec skill so that markup examples include basic HTML markup in the spec. it shouldn't just refer to it, html code blocks should live in there. Also make sure playground and defaul...

Done in the latest commit. Changes include:

  • Updated SKILL.md to require HTML code blocks in every Markup section (showing rendered structure rather than just prose descriptions)
  • Updated all three templates (SPEC.md, spec/default.md, spec/feature.md) with HTML code block placeholders
  • Added HTML markup code blocks to all existing spec files: Banner, Blankslate, and all six DataTable spec files
  • Removed spec parameters from the Default and Playground stories in Banner, Blankslate, and DataTable (feature stories are untouched)

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

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm integration-tests: skipped manually Changes in this PR do not require an integration test skip changeset This change does not need a changelog staff Author is a staff member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants