Skip to content

Comments

chore: consolidate contrib-docs into docs-internal#4281

Merged
NathanFlurry merged 1 commit intomainfrom
chore/consolidate-contrib-docs
Feb 24, 2026
Merged

chore: consolidate contrib-docs into docs-internal#4281
NathanFlurry merged 1 commit intomainfrom
chore/consolidate-contrib-docs

Conversation

@NathanFlurry
Copy link
Member

Summary

  • Consolidates scattered contrib-docs/ directories from docs/, engine/contrib-docs/, contrib-docs/, and rivetkit-typescript/contrib-docs/ into a unified docs-internal/ directory
  • Replays the work from chore: move docs for cleaner nav #4199 which was closed without merging

Test plan

  • Verify no broken references to old contrib-docs paths

@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4281 February 24, 2026 06:09 Destroyed
@railway-app
Copy link

railway-app bot commented Feb 24, 2026

🚅 Deployed to the rivet-pr-4281 environment in rivet-frontend

Service Status Web Updated (UTC)
mcp-hub ✅ Success (View Logs) Web Feb 24, 2026 at 6:11 am
frontend-inspector 🕐 Initializing (View Logs) Web Feb 24, 2026 at 6:11 am
frontend-cloud 🕐 Initializing (View Logs) Web Feb 24, 2026 at 6:11 am
ladle ❌ Build Failed (View Logs) Web Feb 24, 2026 at 6:10 am
website 🕒 Building (View Logs) Web Feb 24, 2026 at 6:10 am

Move scattered contrib-docs from docs/, engine/contrib-docs/,
contrib-docs/, and rivetkit-typescript/contrib-docs/ into a
unified docs-internal/ directory.
@NathanFlurry NathanFlurry force-pushed the chore/consolidate-contrib-docs branch from 26c56b0 to 14ff265 Compare February 24, 2026 06:10
@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4281 February 24, 2026 06:10 Destroyed
Copy link
Member Author


How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@NathanFlurry NathanFlurry merged commit 239ba5d into main Feb 24, 2026
10 of 20 checks passed
@NathanFlurry NathanFlurry deleted the chore/consolidate-contrib-docs branch February 24, 2026 06:11
@claude
Copy link

claude bot commented Feb 24, 2026

PR Review: chore: consolidate contrib-docs into docs-internal

Overall this is a clean organizational improvement. The goal is clear, and the GUARD.md content enhancement is a nice addition on top of the pure rename work. A few things worth looking at:


Issues

1. Typo carried over in directory name

docs-internal/engine/design-choicse/EMBEDDED_KV.md preserves a typo from the original engine/contrib-docs/design-choicse/ path. Since the file is being moved anyway, this is a good opportunity to rename it to design-choices/.

2. RELEASING.md placed under engine/

The original contrib-docs/RELEASING.md lived at the repo root level and covers project-wide release processes (frontend deployment via scripts/git/promote-prod.sh, etc.) — not just the engine. Moving it to docs-internal/engine/RELEASING.md misrepresents its scope. docs-internal/RELEASING.md (top-level) would be more accurate.

3. docs symlink breaks existing path references

Creating docs -> website/src/content repurposes the docs/ entry that previously held internal engineering documentation. Any existing links, bookmarks, or tooling that referenced docs/engine/*.md paths (e.g., in PR descriptions, IDE notes, CI scripts) will now silently resolve to website/src/content/engine/... — which doesn't exist. Consider adding a note or README at the old path, or checking for references before merging.

4. Possible content loss in GUARD.md

The old docs/engine/GUARD.md documented runner WebSocket routing via:

  • path match: /runners/connect
  • Sec-Websocket-Protocol: comma-delimited pairs containing rivet_target.runner

The new consolidated docs-internal/engine/GUARD.md only describes runner routing via the x-rivet-target: runner header. If path-based runner routing still exists in the codebase, it should be preserved in the docs.


Minor Notes

  • The content improvements to GUARD.md (capitalization consistency — "WebSocket" not "websocket", backtick reference to HIBERNATING_WS.md) are good changes.
  • The test plan item "Verify no broken references to old contrib-docs paths" is unchecked. A quick grep -r 'contrib-docs' . across the repo before merging would confirm nothing is missed.
  • The PR description mentions this replays chore: move docs for cleaner nav #4199. Given that docs-internal/ already exists on main (from earlier partial work?), worth confirming there are no unexpected merge conflicts on the file renames before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant