Skip to content

feat: add script and workflow to render SEPs as documentation#2087

Merged
dsp-ant merged 6 commits intomainfrom
claude/render-seps-script-aCl89
Jan 22, 2026
Merged

feat: add script and workflow to render SEPs as documentation#2087
dsp-ant merged 6 commits intomainfrom
claude/render-seps-script-aCl89

Conversation

@dsp-ant
Copy link
Copy Markdown
Member

@dsp-ant dsp-ant commented Jan 14, 2026

Add a system to automatically render Specification Enhancement Proposals
(SEPs) as nicely formatted documentation pages on the website, similar to
how Python renders PEPs.

Changes:

  • Add scripts/render-seps.ts to parse SEPs and generate MDX documentation
  • Add GitHub workflow to auto-render SEPs when seps/ directory changes
  • Generate SEP index page with tabular overview at /community/seps/
  • Generate individual SEP pages with metadata badges and formatted content
  • Add badge snippet component for status/type badges
  • Update docs.json navigation to include SEPs section under Community tab
  • Add npm scripts: generate:seps and check:seps

Add a system to automatically render Specification Enhancement Proposals
(SEPs) as nicely formatted documentation pages on the website, similar to
how Python renders PEPs.

Changes:
- Add scripts/render-seps.ts to parse SEPs and generate MDX documentation
- Add GitHub workflow to auto-render SEPs when seps/ directory changes
- Generate SEP index page with tabular overview at /community/seps/
- Generate individual SEP pages with metadata badges and formatted content
- Add badge snippet component for status/type badges
- Update docs.json navigation to include SEPs section under Community tab
- Add npm scripts: generate:seps and check:seps
Address GitHub Advanced Security comment by adding explicit permissions
block to the workflow. The workflow requires 'contents: write' to push
auto-rendered SEP documentation on the main branch.

Claude-Generated-By: Claude Code (cli/claude-opus-4-5=100%)
Claude-Steers: 0
Claude-Permission-Prompts: 3
Claude-Escapes: 0
@dsp-ant
Copy link
Copy Markdown
Member Author

dsp-ant commented Jan 16, 2026

Addressed the GitHub Advanced Security finding by adding explicit permissions: contents: write block to the workflow. This follows security best practices by explicitly declaring the permissions needed rather than relying on defaults.

The render-seps script now automatically formats generated MDX files
with Prettier to ensure they pass the format check. In check mode,
it compares files after applying Prettier formatting to handle any
formatting differences.

Claude-Generated-By: Claude Code (cli/claude-opus-4-5=100%)
Claude-Steers: 0
Claude-Permission-Prompts: 1
Claude-Escapes: 0
Use semi-transparent backgrounds (500/20) and brighter text (400) in
dark mode for better contrast and readability instead of the previous
dark backgrounds (900) with light text (200).

Claude-Generated-By: Claude Code (cli/claude-opus-4-5=100%)
Claude-Steers: 0
Claude-Permission-Prompts: 0
Claude-Escapes: 0
Mintlify doesn't support all Tailwind dark: classes, so switch to
inline CSS with explicit hex colors. Targets multiple dark mode
selectors (.dark, [data-theme="dark"], prefers-color-scheme) for
compatibility.

Claude-Generated-By: Claude Code (cli/claude-opus-4-5=100%)
Claude-Steers: 5
Claude-Permission-Prompts: 6
Claude-Escapes: 0
Co-Authored-By: Claude <noreply@anthropic.com>
@dsp-ant dsp-ant merged commit f0d3353 into main Jan 22, 2026
1 of 6 checks passed
@dsp-ant dsp-ant deleted the claude/render-seps-script-aCl89 branch January 22, 2026 14:11
shivankgoel pushed a commit to shivankgoel/modelcontextprotocol that referenced this pull request Feb 16, 2026
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.

3 participants