Conversation
858340d to
6fddacd
Compare
Add the public self-hosting guide and contributor-facing hosting modes map. Rename the local development guide so developer setup is not confused with hosting/account modes, and ignore future Superpowers design drafts.
6fddacd to
f0be309
Compare
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
Adds the first pass of Compass self-hosting documentation and clarifies the difference between local development setup and product hosting/account modes.
This PR is docs-only. It intentionally does not implement the future one-command installer; that will happen in a follow-up branch.
What changed
docs/self-hosting.mdfor people manually setting up Compass today.docs/development/hosting-modes.mdfor contributors to understand hosting context, account state, and data ownership.docs/development/env-and-dev-modes.mdtodocs/development/local-development.mdso local developer setup is not confused with hosting modes.docs/superpowers/to.gitignoreso future brainstorming/design drafts do not get committed by default.Why
We identified two separate audiences that needed different docs:
Splitting those concerns keeps the public self-hosting guide approachable while still giving contributors the deeper map they need.
Important behavior captured
FRONTEND_URL/BASEURL/CORS, and MongoDB/SuperTokens reachable from the backend.Validation
mainto ensure this branch is docs-focused.feat/one-cmd-dev-setupbranch todocs/add-self-hosting-docs; the actual installer work will be handled separately.Follow-up work