-
Notifications
You must be signed in to change notification settings - Fork 147
fix(website): output raw MDX for docs markdown #3972
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
fix(website): output raw MDX for docs markdown #3972
Conversation
|
🚅 Deployed to the rivet-pr-3972 environment in rivet-frontend
|
PR Review: fix(website): output raw MDX for docs markdownSummaryThis PR removes MDX/JSX cleaning logic from the docs generation pipeline, preserving the original MDX content (including imports, JSX components, and embedded content) in the generated markdown files under public/docs/. Code QualityStrengths:
Potential Issues:
FunctionalityQuestions:
Edge Cases:
PerformancePositive impact:
SecurityNo security concerns identified:
TestingCurrent Coverage:
Recommendations:
ArchitectureDesign Questions:
VerdictApprove with minor suggestions. The code change is clean and accomplishes the stated goal. The main questions are about the broader architecture and ensuring downstream compatibility. Before merging, I would recommend:
The performance improvement from removing regex processing is a nice bonus! |
More templates
@rivetkit/cloudflare-workers
@rivetkit/db
@rivetkit/framework-base
@rivetkit/next-js
@rivetkit/react
rivetkit
@rivetkit/sql-loader
@rivetkit/virtual-websocket
@rivetkit/engine-runner
@rivetkit/engine-runner-protocol
commit: |
Motivation
public/docs/so downstream tools and viewers see the unmodified source.Description
public/docs/instead of a cleaned version inwebsite/src/integrations/generate-routes.ts.generateMarkdownFilesnow emits the raw MDX content (content) into output files instead ofcleanContentor stripped fragments.processPageare unchanged, so title/description extraction still uses the AST parsing logic.Testing
lefthookpre-commit hook rancargo-fmtas part of the commit and completed successfully.Codex Task