René's URL Explorer Experiment


Title: improvement(docs): make the API reference read as code and unify its type token by waleedlatif1 · Pull Request #6653 · simstudioai/sim · GitHub

Open Graph Title: improvement(docs): make the API reference read as code and unify its type token by waleedlatif1 · Pull Request #6653 · simstudioai/sim

X Title: improvement(docs): make the API reference read as code and unify its type token by waleedlatif1 · Pull Request #6653 · simstudioai/sim

Description: Summary Make the API reference read as code: parameter names, types, and paths were rendering in the body sans face because the page-wide font override outranked .font-mono on specificity Unify the type slot — scalar, union (string | null), array (array), and schema reference each carried their own chip definition and rendered at different sizes, weights, faces, and box heights; they are now one code token reusing the docs inline-code recipe at the platform's 20px chip height Demote row metadata: required and header were filled pills, required on the error token, which made a constraint the loudest thing on the page. Both are now uncontained text, leaving the type token as the only box on a row Fix a live content bug: the rule hiding the trailing In: header line matched p:has(> code), so it also hid the entire API key description on every API reference page. Matched by position now, and the description shortened to one line Pin the two application/json labels and the status-code tabs to one treatment; they rendered the same strings at different weights and faces Match the few lucide glyphs fumadocs renders itself to emcn's 1.55 stroke, so the docs have one icon weight Cleanup in the same pass: removed the four ::-webkit-scrollbar rules (a non-auto scrollbar-width makes Chromium ignore them, so they never ran), an order: 2 block the type-token rule already covered, and the pre-wrap rules that never applied because fumadocs sizes the block with w-max. Named the two repeated values (--font-mono-stack, written out 11 times; --text-code, 9 times) and collapsed the metadata face from seven hand-synced copies into one rule. Type of Change Bug fix Improvement Testing Tested manually against the running docs server in both light and dark themes, verifying computed styles rather than by eye — every type slot now resolves to the same face, size, weight, and 20px box, and the auth chip matches the path chip exactly (57px, was 65px). Confirmed lint:check, check:openapi (7 specs, 135 operations), check:api-validation, docs type-check, and a full docs production build. Notes Deliberately left for a follow-up, since each is a change of a different kind: Syntax highlighting is still the stock Shiki GitHub theme. The platform already defines its own code palette for Monaco (SIM_LIGHT_RULES / SIM_DARK_RULES) — notably strings green rather than blue, which is most of a JSON response body. Both config hooks exist (shikiOptions on createAPIPage, rehypeCodeOptions for MDX); the work is authoring the TextMate scope mapping. The auth row still fabricates header / required / string through CSS content:. All seven specs declare the same apiKey/in: header scheme so it is accurate today, but it is a stylesheet asserting an API fact, and pseudo-element text is not selectable or findable with Cmd+F. renderOperationLayout already receives the dereferenced schema, so an app-owned auth component would read it properly. renderHeading and renderCodeBlock would let us drop fumadocs' lucide glyphs for the emcn Heading/CodeBlock components the app already owns, retiring the stroke-width rule. Checklist Code follows project style guidelines Self-reviewed my changes Tests added/updated and passing No new warnings introduced I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

Open Graph Description: Summary Make the API reference read as code: parameter names, types, and paths were rendering in the body sans face because the page-wide font override outranked .font-mono on specificity Unify th...

X Description: Summary Make the API reference read as code: parameter names, types, and paths were rendering in the body sans face because the page-wide font override outranked .font-mono on specificity Unify th...

Opengraph URL: https://github.com/simstudioai/sim/pull/6653

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:226b3f1b-3288-8e1f-a33d-eae6eef34d8b
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id86AE:3988A1:A36680:E089AC:6AFB5006
html-safe-nonce27c81230ccb25266ca00c604ffa809c257b3ec06a54dd4f05b4bfa02887b02af
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NkFFOjM5ODhBMTpBMzY2ODA6RTA4OUFDOjZBRkI1MDA2IiwidmlzaXRvcl9pZCI6IjUzNDEyNTY0MzgxNjMxMzI0MjIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac56f07dcf4e1e75de335ad9afd1b4f4bbcce781d103d06d364e3418daefb4a409
hovercard-subject-tagpull_request:4267459168
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/simstudioai/sim/pull/6653/files
twitter:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/40672544?s=400&v=4
og:image:altSummary Make the API reference read as code: parameter names, types, and paths were rendering in the body sans face because the page-wide font override outranked .font-mono on specificity Unify th...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None7122bb414b542dba14d71a3f0b9f6fd2abce715b9f5912d082800563e6c806d1
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/simstudioai/sim git https://github.com/simstudioai/sim.git
octolytics-dimension-user_id199344406
octolytics-dimension-user_loginsimstudioai
octolytics-dimension-repository_id912559512
octolytics-dimension-repository_nwosimstudioai/sim
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id912559512
octolytics-dimension-repository_network_root_nwosimstudioai/sim
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasecbf66c024bb6d10e6955baa7413c54cf13a201bb
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/simstudioai/sim/pull/6653/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F6653%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fsimstudioai%2Fsim%2Fpull%2F6653%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=simstudioai%2Fsim
Reloadhttps://github.com/simstudioai/sim/pull/6653/files
Reloadhttps://github.com/simstudioai/sim/pull/6653/files
Reloadhttps://github.com/simstudioai/sim/pull/6653/files
simstudioaihttps://github.com/simstudioai
simhttps://github.com/simstudioai/sim
Codehttps://github.com/simstudioai/sim
Issues129 (129)https://github.com/simstudioai/sim/issues
Pull requests197 (197)https://github.com/simstudioai/sim/pulls
Actionshttps://github.com/simstudioai/sim/actions
Projectshttps://github.com/simstudioai/sim/projects
Security and qualityhttps://github.com/simstudioai/sim/security
Insightshttps://github.com/simstudioai/sim/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fsimstudioai%2Fsim%2Fissues%2Fnew%2Fchoose
waleedlatif1https://github.com/waleedlatif1
staginghttps://github.com/simstudioai/sim/tree/staging
improvement/docs-api-ref-designhttps://github.com/simstudioai/sim/tree/improvement/docs-api-ref-design
Conversation 13 https://github.com/simstudioai/sim/pull/6653
Commits 8 https://github.com/simstudioai/sim/pull/6653/commits
Checks 30 https://github.com/simstudioai/sim/pull/6653/checks
Files changed https://github.com/simstudioai/sim/pull/6653/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6653/files
improvement(docs): make the API reference read as code and unify its type token https://github.com/simstudioai/sim/pull/6653/files#top
Show all changes 8 commits https://github.com/simstudioai/sim/pull/6653/files
6f5e2ec improvement(docs): make the API reference read as code, and unify the… waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/6f5e2eceb72f7670cd78bb1343cdafd638aa54d4
482b086 improvement(docs): mono status-code tabs, and match fumadocs' lucide … waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/482b0865fa0a7d6cddbf2f4c4288b7130e3dd39e
f26cf0b fix(docs): align the auth type chip with every other property row, an… waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/f26cf0b286aedd7bd4694f0ee6affc514deb9a73
7d301ff revert(docs): let example code overflow instead of wrapping waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/7d301ff755a0bac0c01560d626846777b8e3dfa5
c6a7718 fix(docs): tighten array type tokens and keep the union separator leg… waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/c6a77184473df87b7481e18fdf3013897c67d440
3eee09b fix(docs): restore the hidden API key description, and drop dead API-… waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/3eee09bfd058ff94a669b3518cca8a5fcf5de835
5a53f66 refactor(docs): define the API-reference chrome once, and cut the com… waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/5a53f662188457d13c8cb122d2d389340fde1e5d
256147f fix(docs): keep the union separator in the type token's own face waleedlatif1 Aug 13, 2026 https://github.com/simstudioai/sim/pull/6653/commits/256147f4d16bb7d9a21999e945a396711d6fca56
Clear filters https://github.com/simstudioai/sim/pull/6653/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6653/files
Please reload this pagehttps://github.com/simstudioai/sim/pull/6653/files
global.css https://github.com/simstudioai/sim/pull/6653/files#diff-9805837ec07d660373de421b1f841528f02474afa6170acac4f1efecccfc0399
openapi-v2-billing.json https://github.com/simstudioai/sim/pull/6653/files#diff-d1a7579e3381b5f6f39f2f304f56201fbf944a23caa31b5ecc165988a85a6eb4
openapi-v2-files-audit.json https://github.com/simstudioai/sim/pull/6653/files#diff-c6918d7f933ec43ee8b8a4983d19f272b35962e2510bad721fc05d6d82b41b8d
openapi-v2-knowledge.json https://github.com/simstudioai/sim/pull/6653/files#diff-c15da3de30ec533f5aedd9a2862e8afdb8e2a58490fe681b97959638218bf99e
openapi-v2-logs.json https://github.com/simstudioai/sim/pull/6653/files#diff-303943bbe4957dfce964c583968a279a8fddba1850a9ada9273d00b5498f8a75
openapi-v2-resources.json https://github.com/simstudioai/sim/pull/6653/files#diff-17e168777a3b67e689dd8b24e28aaa217cb884843dccad31b1dbf22d5307e17f
openapi-v2-tables.json https://github.com/simstudioai/sim/pull/6653/files#diff-ce7e6e983230c870183cf99d3e224cd90a9b070ad038113d581d755a0386043b
openapi-v2-workflows.json https://github.com/simstudioai/sim/pull/6653/files#diff-811f737e7f97ec52156a37e71892822626b5b4de295efebd20992198d162149b
shared.ts https://github.com/simstudioai/sim/pull/6653/files#diff-de04a2f2a3526e0173b51672e735d59e9172fb12b2ac2cee63190fb5dfc777b1
apps/docs/app/global.csshttps://github.com/simstudioai/sim/pull/6653/files#diff-9805837ec07d660373de421b1f841528f02474afa6170acac4f1efecccfc0399
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/app/global.css
Open in desktop https://desktop.github.com
Please reload this pagehttps://github.com/simstudioai/sim/pull/6653/files
apps/docs/openapi-v2-billing.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-d1a7579e3381b5f6f39f2f304f56201fbf944a23caa31b5ecc165988a85a6eb4
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-billing.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-d1a7579e3381b5f6f39f2f304f56201fbf944a23caa31b5ecc165988a85a6eb4
https://github.com/simstudioai/sim/pull/6653/files#diff-d1a7579e3381b5f6f39f2f304f56201fbf944a23caa31b5ecc165988a85a6eb4
apps/docs/openapi-v2-files-audit.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-c6918d7f933ec43ee8b8a4983d19f272b35962e2510bad721fc05d6d82b41b8d
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-files-audit.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-c6918d7f933ec43ee8b8a4983d19f272b35962e2510bad721fc05d6d82b41b8d
https://github.com/simstudioai/sim/pull/6653/files#diff-c6918d7f933ec43ee8b8a4983d19f272b35962e2510bad721fc05d6d82b41b8d
apps/docs/openapi-v2-knowledge.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-c15da3de30ec533f5aedd9a2862e8afdb8e2a58490fe681b97959638218bf99e
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-knowledge.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-c15da3de30ec533f5aedd9a2862e8afdb8e2a58490fe681b97959638218bf99e
https://github.com/simstudioai/sim/pull/6653/files#diff-c15da3de30ec533f5aedd9a2862e8afdb8e2a58490fe681b97959638218bf99e
apps/docs/openapi-v2-logs.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-303943bbe4957dfce964c583968a279a8fddba1850a9ada9273d00b5498f8a75
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-logs.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-303943bbe4957dfce964c583968a279a8fddba1850a9ada9273d00b5498f8a75
https://github.com/simstudioai/sim/pull/6653/files#diff-303943bbe4957dfce964c583968a279a8fddba1850a9ada9273d00b5498f8a75
apps/docs/openapi-v2-resources.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-17e168777a3b67e689dd8b24e28aaa217cb884843dccad31b1dbf22d5307e17f
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-resources.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-17e168777a3b67e689dd8b24e28aaa217cb884843dccad31b1dbf22d5307e17f
https://github.com/simstudioai/sim/pull/6653/files#diff-17e168777a3b67e689dd8b24e28aaa217cb884843dccad31b1dbf22d5307e17f
apps/docs/openapi-v2-tables.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-ce7e6e983230c870183cf99d3e224cd90a9b070ad038113d581d755a0386043b
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-tables.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-ce7e6e983230c870183cf99d3e224cd90a9b070ad038113d581d755a0386043b
https://github.com/simstudioai/sim/pull/6653/files#diff-ce7e6e983230c870183cf99d3e224cd90a9b070ad038113d581d755a0386043b
apps/docs/openapi-v2-workflows.jsonhttps://github.com/simstudioai/sim/pull/6653/files#diff-811f737e7f97ec52156a37e71892822626b5b4de295efebd20992198d162149b
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/docs/openapi-v2-workflows.json
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-811f737e7f97ec52156a37e71892822626b5b4de295efebd20992198d162149b
https://github.com/simstudioai/sim/pull/6653/files#diff-811f737e7f97ec52156a37e71892822626b5b4de295efebd20992198d162149b
apps/sim/lib/api/contracts/v2/openapi/shared.tshttps://github.com/simstudioai/sim/pull/6653/files#diff-de04a2f2a3526e0173b51672e735d59e9172fb12b2ac2cee63190fb5dfc777b1
View file https://github.com/simstudioai/sim/blob/256147f4d16bb7d9a21999e945a396711d6fca56/apps/sim/lib/api/contracts/v2/openapi/shared.ts
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/simstudioai/sim/pull/6653/{{ revealButtonHref }}
https://github.com/simstudioai/sim/pull/6653/files#diff-de04a2f2a3526e0173b51672e735d59e9172fb12b2ac2cee63190fb5dfc777b1
https://github.com/simstudioai/sim/pull/6653/files#diff-de04a2f2a3526e0173b51672e735d59e9172fb12b2ac2cee63190fb5dfc777b1
Please reload this pagehttps://github.com/simstudioai/sim/pull/6653/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.