chore(docs): stop tracking generated OpenAPI doc output - #287
Conversation
The docusaurus-plugin-openapi-docs output (*.api.mdx, *.info.mdx, sidebar.js, and their JSON sidecars) is regenerated by `yarn gen:api` and shouldn't be committed. Removing it now, ahead of the Docusaurus v3 upgrade, keeps that PR's diff to actual source changes instead of hundreds of regenerated files.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: 4 reviews are currently available. Based on recent review activity, included reviews refill at 5 per hour. WalkthroughThe change removes generated SDK API and Web Console API documentation pages, including endpoint metadata, schemas, examples, and response details. It also removes the related sidebar exports. The Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change stops tracking generated API documentation while preserving regeneration through updated ignore rules; no actionable merge-blocking risk remains after normal checks. Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for absmartly-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Address review feedback (PR #287): explicitly listing every generated filename pattern is fragile — it silently misses whatever new sidecar file a future plugin bump emits, exactly like the pre-upgrade .gitignore missed the *.ParamsDetails.json/etc files this branch had to clean up. Ignore everything in the two output directories and carve back out only the hand-authored files (_category_.json, the Examples/ page).
…l SVGs Rebased onto master now that #282/#287/#288 landed. Swaps the inline SVG diagrams from #282 for editorial versions built via the diagram-design skill: real infra icons (phone, database, bucket, filter, search, cloud, chart) instead of plain labeled boxes, and the Hybrid diagram's ABsmartly Cloud node correctly reflects that it still holds managed- source data rather than reusing Fully mode's "no user-level data stored" claim. Prose and topology are otherwise unchanged from master.
2 participants
Summary
docusaurus-plugin-openapi-docs(*.api.mdx,*.info.mdx,sidebar.js) underdocs/APIs-and-SDKs/SDK-APIanddocs/APIs-and-SDKs/Web-Console-API.gitignoreso this output (and its JSON sidecars /sidebar.ts) stays untracked going forward — the previous patterns pointed at the wrong paths and didn't cover the plugin's newer per-endpoint JSON filesTest plan
yarn gen:apiregenerates the docs locally andgit statusstays clean (confirms the ignore patterns match)yarn buildsucceedsSummary by CodeRabbit
Documentation
Chores