docs(api): remove stack onboarding guides from /api/docs#3460
Merged
PierreBrisorgueil merged 1 commit intomasterfrom Apr 13, 2026
Merged
docs(api): remove stack onboarding guides from /api/docs#3460PierreBrisorgueil merged 1 commit intomasterfrom
PierreBrisorgueil merged 1 commit intomasterfrom
Conversation
Delete modules/core/doc/guides/{getting-started,authentication,organizations}.md.
These are stack-private backend developer onboarding docs, not public API
documentation. They were surfaced in every downstream project's /api/docs
(e.g. https://api.trawl.me/api/docs) via the Scalar reference, exposing
irrelevant "npm install / localhost:3000" content to project consumers.
Convention going forward: the stack ships zero public API guides. Each
downstream project owns the content rendered in its own /api/docs via its
own modules' doc/guides/*.md files.
Tests that exercised the guide loader against these specific files now
use temporary fixtures under /tmp instead, so the loader behavior is
still covered without depending on stack-owned content. The integration
test on /api/spec.json no longer asserts on specific guide titles.
The glob `modules/*/doc/guides/*.md` and `guidesHelper.loadGuides` already
handle an empty guide list gracefully (see the no-op merge branch).
Closes #3457
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (5)
💤 Files with no reviewable changes (3)
WalkthroughRemoves three stack-onboarding documentation guides (getting-started, authentication, organizations) from public API reference to prevent downstream projects from inheriting backend developer instructions. Updates tests to use temporary guides and relaxes OpenAPI spec assertions that previously validated guide content presence. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~14 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Removes stack-private onboarding markdown guides from the Core module so downstream projects no longer publicly expose backend developer setup content via /api/docs (Scalar), and updates Core tests to avoid depending on the removed files.
Changes:
- Deleted Core markdown guides previously merged into the OpenAPI
info.description. - Reworked unit tests to generate temporary guide fixtures under
/tmpinstead of reading deleted repo files. - Relaxed the
/api/spec.jsonintegration assertion to validate the OpenAPI info block without requiring guides to exist.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| modules/core/tests/core.unit.tests.js | Updates guide-loader-related unit tests to use temporary markdown fixtures and adjusts title expectations. |
| modules/core/tests/core.integration.tests.js | Updates /api/spec.json integration test to assert a valid OpenAPI info block without requiring info.description. |
| modules/core/doc/guides/getting-started.md | Removed stack onboarding guide from publicly surfaced API docs. |
| modules/core/doc/guides/authentication.md | Removed stack onboarding guide from publicly surfaced API docs. |
| modules/core/doc/guides/organizations.md | Removed stack onboarding guide from publicly surfaced API docs. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3460 +/- ##
=======================================
Coverage 85.81% 85.81%
=======================================
Files 115 115
Lines 2911 2911
Branches 805 805
=======================================
Hits 2498 2498
Misses 327 327
Partials 86 86 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
modules/core/doc/guides/{getting-started,authentication,organizations}.md— these are stack-private backend onboarding docs that were being surfaced publicly via every downstream project's/api/docsthrough the Scalar API reference.core.unit.tests.js+core.integration.tests.jsso the guide-loader tests use temporary/tmpfixtures instead of depending on the deleted stack files.Why
Each downstream project (trawl, comes, montaine, pierreb, ...) exposed backend-developer instructions like "clone the repo, npm install, localhost:3000" at its public API docs URL (e.g. https://api.trawl.me/api/docs#description/getting-started). Those guides are irrelevant to API consumers and talked about a stack they do not know exists.
Convention going forward
The stack ships zero public API guides. Each downstream project owns the markdown rendered in its own
/api/docsvia its own modules'doc/guides/*.md. The guide loader (lib/helpers/guides.js) and theconfig/assets.jsglobmodules/*/doc/guides/*.mdalready handle an empty guide list gracefully, so no loader changes were needed.Downstream cleanup will follow via
/update-stackpropagation on each project.Test plan
npm run lint— cleannpm run test:coverage— 766/766 green, no coverage regression/tmpfixtures (no dependency on deleted files)/api/spec.jsonintegration test asserts onopenapi+info.version+ optionalinfo.description— works whether or not any module ships a guideCloses #3457
Summary by CodeRabbit
Documentation
Tests