Add full self-hosting documentation for GCP - #313
Open
rakesh-snippyly wants to merge 3 commits into
Open
Conversation
…der Partial Renames the "Self-Host Data" navigation group to "Self Hosting" and introduces a "Partial Self Hosting" subgroup so a "Full Self Hosting" subgroup can sit alongside it. The nine existing data-provider pages move from self-host-data/ to self-hosting/partial/ and keep their content unchanged. Cross-file impact: - docs.json: group renamed, pages nested under Partial Self Hosting, and nine redirects added from /self-host-data/<page> to /self-hosting/partial/<page> plus a /self-host-data section-root redirect, so inbound links keep working. - Cross-references rewritten in data-models.mdx, api-methods.mdx, add-notifications.mdx, customize-behavior.mdx, backend-sdks/python.mdx and the v4/v5/v6 SDK changelogs. - Path globs updated in SKILLS_SYNC_PIPELINE.md and the skills-sync mapping. - Historical agent logs under .claude/ deliberately left untouched. - The "Self-Host Data Documentation" link label in python.mdx becomes "Partial Self Hosting Documentation" to match the new section names. The Full Self Hosting pages and their navigation land in a follow-up commit so this one leaves no navigation entry pointing at a missing page.
Adds the Full Self Hosting subgroup alongside Partial Self Hosting, ported from the four source guides in the shared-firebase-function repo. New pages: - self-hosting/full/overview: concepts, architecture, core-concept table, what is included, security checklist, limitations, and a supported-clouds table. Also contrasts full against partial self-hosting so readers land in the right section. - self-hosting/full/gcp/overview: the short Get Started page. Written for a junior engineer whose main job is handing the install guide to an AI coding agent, with prerequisites, the inputs decided once, a copy-pasteable starter prompt, the five human steps, app wiring, and acceptance criteria. - self-hosting/full/gcp/install: the agent-executable greenfield procedure, Phase 0 through 6 plus the troubleshooting appendix. - self-hosting/full/gcp/upgrade: the agent-executable delta upgrade procedure, Phase U0 through U4 plus upgrade troubleshooting. - self-hosting/full/gcp/reference: manifest schema, trust model, deployment profiles, selfHosted and console config shapes, state file contract, and acceptance criteria. - self-hosting/full/aws and self-hosting/full/azure: closed beta, with what is available today and what to include in an access request. All 59 code blocks across the three ported runbooks are byte-identical to their sources, so every command, digest, flag, and value is preserved. Prose was converted to house style (no em-dashes) without touching fence contents. Relative .md links now resolve to absolute docs paths. docs.json: Full Self Hosting group added under Self Hosting with a nested GCP group, plus section-root redirects for /self-hosting, /self-hosting/full, and /self-hosting/full/gcp.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Mintlify publishes any .md/.mdx it finds, regardless of whether the file is
in docs.json navigation. Seven internal files at the repo root and under
.github/ were therefore being served on the live site:
/CLAUDE the internal docs writing guide
/README the repo readme
/SKILLS_SYNC_PIPELINE the internal skills-sync pipeline doc
/WIREFRAME_VARIABLES_TEMPLATE an internal authoring template
/temp-release-notes scratch release-notes artifact
/temp-release-notes-input scratch release-notes artifact
/.github/release-note-pipeline/README CI automation doc that names an
internal repository
Verified live on production before this change (velt.dev/docs/CLAUDE and
velt.dev/docs/SKILLS_SYNC_PIPELINE both returned real content).
Adds all seven plus .github/** to docs.json "ignore" and .mintignore, matching
the existing convention for .claude/, scripts/, and .pipeline-scratch/. No page
listed in navigation is affected. Mintlify already excludes snippets/, which
correctly 404s.
Not addressed here: 65 product pages exist on disk but are absent from
docs.json navigation, so they are reachable by direct URL only. That is an
editorial question (deprecate, redirect, or link) rather than a leak.
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
2 participants
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
This PR adds comprehensive documentation for Velt's full self-hosting offering on GCP, including installation, upgrade, and reference guides. It also reorganizes the existing partial self-hosting documentation under a new "Self Hosting" umbrella in the navigation.
Key Changes
New full self-hosting docs:
self-hosting/full/overview.mdx: High-level overview of full self-hosting vs. partial self-hostingself-hosting/full/gcp/overview.mdx: Quick-start guide for GCP deploymentsself-hosting/full/gcp/install.mdx: Comprehensive agent-executable installation procedure (1,326 lines) covering 6 phases: release resolution, project bootstrap, backend deployment, workspace provisioning, console setup, and SDK hostingself-hosting/full/gcp/upgrade.mdx: Upgrade guide for moving existing deployments to newer releasesself-hosting/full/gcp/reference.mdx: Field-level reference for release registry, manifest schema, deployment profiles, and trust verificationself-hosting/full/aws.mdxandself-hosting/full/azure.mdx: Placeholder pages for closed-beta cloud platformsReorganized navigation:
self-host-data/directory toself-hosting/partial/to establish a clear hierarchydocs.jsonto group partial and full self-hosting under a unified "Self Hosting" section with cloud-provider subgroupsUpdated references:
api-reference/sdk/api/api-methods.mdx,backend-sdks/python.mdx, and other files to use newself-hosting/partial/pathsSKILLS_SYNC_PIPELINE.mdto reflect the new directory structureNotable Implementation Details
velt-selfhost-state.json) is defined as a JSON schema to enable resume capability across interrupted deployments.https://claude.ai/code/session_01GLN1QuGPxu3oJLTxfZSRT8