docs(rees): lead with self-host docker-compose, retire our Railway deployment - #3883
Conversation
…ployment Self-host REES via docker-compose (added just before this change) is now production-validated end-to-end on edge-us-01, so re-frame the docs around it as the recommended default rather than an afterthought under an external/managed-instance-first structure: - docs.self-hosting-rees.tsx: merge the separate "Engine configuration" and "Self-hosting REES" sections into one "Run REES" flow that leads with the in-network docker-compose path, with "point at an external or managed instance instead" demoted to an explicit alternative. - review-enrichment/README.md: drop the "standalone Railway microservice" framing, generalize the /health and stale-build notes (neither is Railway-specific), and note self-hosting as the simplest path ahead of the Railway deploy section. - Remove review-enrichment/railway.json: the actual Railway project this repo's own instance depended on has been decommissioned (its self-hosted engine now points at the in-network rees service instead), so the config file describing that deployment is stale. The Railway deploy path itself remains documented and supported for anyone who wants it — only our own no-longer-used config is removed. Unrelated top-level railway.json (the separate, still-valid Railway deploy option for the main self-host image) and the generic "railway.json" infra-file pattern in src/signals/path-matchers.ts are untouched.
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | 4f9b5c6 | Commit Preview URL Branch Preview URL |
Jul 07 2026, 03:18 AM |
|
Warning 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨 ⏸️ Gittensory review result - manual review recommendedReview updated: 2026-07-07 03:54:04 UTC
⏸️ Suggested Action - Manual Review
Review summary Nits — 5 non-blocking
Concerns raised — review before merging
Review context
Contributor next steps
Signal definitions
🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
Summary
docker compose --profile rees(added just before this PR) is now production-validated end-to-end on edge-us-01 (real/v1/enrichcall, full analyzer registry ran,HTTP 200). This PR re-frames the docs around it as the recommended default instead of an afterthought under an external-instance-first structure, and cleans up the config for the Railway deployment gittensory itself no longer uses.apps/gittensory-ui/src/routes/docs.self-hosting-rees.tsx: merges the previously-separate "Engine configuration" and "Self-hosting REES" sections into one "Run REES" flow that leads with the in-network docker-compose path (no separate service to host), with "point at an external or managed instance instead" demoted to an explicit, clearly-alternative subsection. Removes the duplicate.envblocks the old structure had.review-enrichment/README.md: drops the "standalone Railway microservice" opening framing (REES is deployment-target-agnostic), generalizes the/healthendpoint description and the stale-build note in "Shared analysis context" (neither is actually Railway-specific), and points at self-hosting as the simplest path ahead of the Railway deploy section.review-enrichment/railway.json: this repo's own self-hosted engine (edge-us-01) has been fully cut over to the in-networkreesservice and no longer depends on the Railway deployment that config pointed at. That Railway project (enrichment-gittensory) has separately been decommissioned via the Railway CLI. The Railway deploy path itself remains documented and supported in the README for anyone who wants to run REES there — only our own no-longer-used project config is removed.railway.json(a separate, still-valid Railway deploy option for the main self-host image, unrelated to REES) and the generic"railway.json"infra-file-pattern entry insrc/signals/path-matchers.ts(used to recognize Railway configs in any repo gittensory reviews, unrelated to gittensory's own deployment).Scope
type(scope): short summaryConventional Commit format, for examplefix(api): restore profile access checks.CONTRIBUTING.mdand does not reintroduce GitHub Pages, VitePress,site/, orCNAME.Validation
git diff --checknpm run actionlintnpm run typechecknpm run test:coveragelocally;codecov/patchrequires ≥99% coverage of the lines AND branches you changed (aim for 100% on your diff so CI variance does not fail near the threshold). Global coverage is a non-blocking trend with a loose 90% backstop, not the gate.npm run test:workersnpm run build:mcpnpm run test:mcp-packnpm run ui:openapi:checknpm run ui:lintnpm run ui:typechecknpm run ui:buildnpm audit --audit-level=moderateAll run via
npm run test:ci(full local gate, green) plus a standalonenpm audit --audit-level=moderate(0 vulnerabilities). This is a docs/config-removal-only change (nosrc/**logic touched), so there's no new branch coverage obligation — verified viaui:lint/ui:typecheck/ui:buildthat the doc page still compiles and renders correctly after the restructure.Beyond the local gate, I did live infrastructure verification (not something CI can check): confirmed on edge-us-01 that the in-network
reescontainer is healthy, the engine's post-cutover/v1/pinghandshake succeeded (rees_ping_ok), and a real synthetic/v1/enrichcall through the container network returned a fullHTTP 200ReviewBriefwith the complete analyzer registry executing (including network-calling analyzers likedependency/license). Separately confirmed viarailway link -p enrichment-gittensorythat the old Railway project no longer exists in the account.Safety
UI Evidencesection below with JPG/JPEG or PNG screenshots arranged as organized, captioned, clickable thumbnails.Docs-and-config-only change: no auth/CORS/session/API behavior touched. The doc page shows static reference content (no live data to mock), so no UI Evidence table applies — this is prose/config restructuring, not a visual/interactive change.
UI Evidence
N/A — text/prose restructuring on an existing docs page; no visual or interactive change.
Notes
railway delete) and the edge-us-01 cutover to the in-network REES service happened outside this repo/PR — this PR is the documentation and repo-config side of that already-completed operational change.