Skip to content

Add Markdown formatter and check for Clerk skills - #117

Merged
SarahSoutoul merged 7 commits into
mainfrom
ss/DOCS-12092
Nov 10, 2026
Merged

SarahSoutoul merged 7 commits into
mainfrom
ss/DOCS-12092

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

What does this solve? What changed?

DOCS-12373 adds a consistent Markdown formatter to clerk/skills. Tables and spacing had drifted without a formatting check.

  • Pin Oxfmt 0.77.0 with semi: false, singleQuote: true, and proseWrap: "never". Fenced code examples are formatted too.
  • Add format:skills and check:format; the existing pnpm run check includes the formatting check in CI.
  • Run pnpm run format:skills across the skills. Split the two mixed server/client examples so the use client directive stays valid, and put the Enterprise SSO firstName and lastName fields on separate lines.
  • Replace the hand-added escaped pipe in the Next.js matcher table with separate '/api(.*)' and '/trpc(.*)' patterns that agents can copy directly.
  • Wrap eight JSX examples in components so Oxfmt does not add a leading semicolon before bare JSX.

With wide-table padding removed, clerk-billing is at 4,991 estimated tokens and clerk-orgs is at 4,945, both under the 5,000-token limit. This branch passes Check on its own. #118 is stacked on this branch to remove repeated instructions and create room for future edits. It has been updated against the latest #117 branch and is ready for review; merge #118 into this branch before merging #117 into main.

Verification

  • pnpm run format:skills completed.
  • pnpm test passes (152 tests).
  • pnpm run check passes locally. Docs-link redirects are non-blocking warnings.
  • Required Check and Test workflows pass on the pushed commit.
  • Review the final diff and obtain code owner approval before merging.

Deadline

No fixed deadline. The do not merge label remains until the final diff is reviewed.

Other resources

@SarahSoutoul SarahSoutoul added the do not merge Prevents PRs from being merged while label is applied. label Nov 6, 2026
@SarahSoutoul SarahSoutoul self-assigned this Nov 6, 2026
@SarahSoutoul
SarahSoutoul marked this pull request as ready for review November 6, 2026 19:54
@SarahSoutoul
SarahSoutoul requested review from a team as code owners November 6, 2026 19:54
Comment thread package.json Resolved
@manovotny manovotny self-assigned this Nov 9, 2026
@SarahSoutoul

Copy link
Copy Markdown
Contributor Author

@manovotny This is now using oxfmt!

@manovotny manovotny left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Formatting code blocks rewrites three example lines into code an agent shouldn't copy:

  • server-vs-client.md lines 25 and 99: 'use client' follows server code in the same block, so it's no longer a directive and becomes ;('use client'). Splitting each into separate server and client blocks fixes it.
  • enterprise-sso.md line 43: ssoAccount.firstName, ssoAccount.lastName becomes ;(ssoAccount.firstName, ssoAccount.lastName). One field per line fixes it.

Both fixes pass check:format with the suggested config.

Comment thread .oxfmtrc.json Resolved
Comment thread skills/clerk-nextjs-patterns/SKILL.md Resolved
@SarahSoutoul

SarahSoutoul commented Nov 10, 2026 •

Copy link
Copy Markdown
Contributor Author

@manovotny Fixed the three examples in your review summary: the two server/client examples are now separate code blocks, so use client stays a directive, and the SSO account fields are on separate lines. Commit here.

Comment thread skills/clerk-orgs/SKILL.md Resolved
Comment thread skills/clerk-orgs/SKILL.md Resolved
@SarahSoutoul SarahSoutoul removed the do not merge Prevents PRs from being merged while label is applied. label Nov 10, 2026
@SarahSoutoul
SarahSoutoul merged commit 402150c into main Nov 10, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants