Skip to content

Comments

docs: workflows#4256

Merged
NathanFlurry merged 1 commit intomainfrom
02-21-docs_workflows
Feb 24, 2026
Merged

docs: workflows#4256
NathanFlurry merged 1 commit intomainfrom
02-21-docs_workflows

Conversation

@NathanFlurry
Copy link
Member

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4256 February 22, 2026 04:49 Destroyed
@railway-app
Copy link

railway-app bot commented Feb 22, 2026

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

Service Status Web Updated (UTC)
website 😴 Sleeping (View Logs) Web Feb 22, 2026 at 9:18 pm
mcp-hub ✅ Success (View Logs) Web Feb 22, 2026 at 9:07 pm
frontend-inspector ❌ Build Failed (View Logs) Web Feb 22, 2026 at 9:07 pm
frontend-cloud ❌ Build Failed (View Logs) Web Feb 22, 2026 at 9:07 pm
ladle ❌ Build Failed (View Logs) Web Feb 22, 2026 at 9:07 pm

Copy link
Member Author

NathanFlurry commented Feb 22, 2026


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.

@claude
Copy link

claude bot commented Feb 22, 2026

PR Review: docs: workflows

This PR restructures and rewrites documentation for workflows, access control, events, state/persistence, and queues, along with fixing URL redirects and updating generated icon files.

Overall Assessment

A substantial documentation improvement. The workflows page now covers far more patterns (loops, setup/teardown, queue-driven work), the access control model moves from a single canInvoke hook to per-surface authorization, and the sitemap organization is noticeably cleaner. Issues below are minor.


Bugs / Correctness

1. Redirect direction corrected
The old '/docs/actors/queues' → '/docs/actors/queue/' was backwards. The new direction '/docs/actors/queue' → '/docs/actors/queues/' is correct.

2. Dead link: /docs/actors/design-patterns
website/src/sitemap/mod.ts adds a navigation entry pointing to /docs/actors/design-patterns, but no design-patterns.mdx is added in this PR. Verify the page already exists or this will 404 in production.

3. Commented-out icons produce noisy sitemap code
Several icons are left as comments in mod.ts. Either assign a real icon or remove the comment lines entirely.

4. Potentially unused imports in mod.ts
faSquareList and faGrid are added to the import block but do not appear to be used in any visible part of the diff. Worth verifying they are actually referenced somewhere in the file.


Documentation Content

5. canInvoke removal not called out for users upgrading
access-control.mdx and lifecycle.mdx fully replace canInvoke with per-surface canPublish/canSubscribe + action-level checks. If canInvoke still exists in the SDK (even as deprecated), a note or migration callout would help users who have existing canInvoke handlers.

6. authenticate() called twice per connection in the access-control example
Both onBeforeConnect and createConnState call await authenticate(params.authToken). This works but causes two auth lookups per connection. The example should either combine both into createConnState (since throwing there also rejects the connection) or add a short comment explaining the duplication is intentional.

7. event<[]>() as a zero-payload event type
In events.mdx, event<[]>() (empty tuple type) is used for a gameStarted event. This is valid TypeScript but is an unusual idiom. event<void>() or a bare event() would be less surprising to most readers.

8. Multiplayer cookbook removed detailed auth tables without a replacement
Two tables in website/src/content/cookbook/multiplayer-game.mdx were deleted: "Access Control Rules By Mechanism" and "Actor Ownership Constraints". These documented auth and ownership policy for all eight game archetypes in one place. If they were removed for accuracy reasons (because canInvoke no longer exists), consider linking to the updated access control docs or adding a brief prose replacement so the cookbook remains self-contained.


Generated Files

9. +68,956 lines of generated JS committed
frontend/packages/icons/dist/index.js, src/index.gen.js, and src/index.gen.ts are auto-generated build artifacts. The massive diff makes code review harder and inflates git history. Consider adding these to .gitignore and generating them at build time, or using git-lfs.


Summary

Area Verdict
URL/redirect fixes ✅ Correct
Workflow docs rewrite ✅ Much more comprehensive
Access control rewrite (per-surface auth) ✅ Clearer model
Events docs typed with event<T>() ✅ Good
State renamed to "In-Memory State" ✅ Clearer
New persistence overview page ✅ Useful landing page
Sitemap restructure ✅ Better organization
Debugging sections added across docs ✅ Helpful additions
Dead /docs/actors/design-patterns link ⚠️ Verify page exists
Multiplayer cookbook tables removed ⚠️ Add cross-reference or update in place
canInvoke removal not flagged for upgraders ⚠️ Add a migration note
Commented-out icons ℹ️ Cleanup noise
Unused faSquareList/faGrid imports ℹ️ Verify or remove
Double authenticate() in example ℹ️ Add a comment explaining the pattern
Committed generated dist files ℹ️ Consider .gitignore

@NathanFlurry NathanFlurry changed the base branch from 02-21-chore_inspector_add_back_database_tab to graphite-base/4256 February 22, 2026 21:06
@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4256 February 22, 2026 21:06 Destroyed
@NathanFlurry NathanFlurry changed the base branch from graphite-base/4256 to 02-22-chore_rivetkit_update_conns_to_be_hibernatable February 22, 2026 21:07
@NathanFlurry NathanFlurry marked this pull request as ready for review February 23, 2026 06:41
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch from 57c3534 to 033c3b9 Compare February 23, 2026 08:25
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch from 033c3b9 to 7d43770 Compare February 23, 2026 18:22
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch 2 times, most recently from 033c3b9 to d8a30c7 Compare February 23, 2026 18:35
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch from d8a30c7 to c2be680 Compare February 24, 2026 02:39
@NathanFlurry NathanFlurry mentioned this pull request Feb 24, 2026
11 tasks
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch from 310b793 to d8a30c7 Compare February 24, 2026 03:19
@NathanFlurry NathanFlurry force-pushed the 02-22-chore_rivetkit_update_conns_to_be_hibernatable branch from d8a30c7 to 326942f Compare February 24, 2026 04:01
Base automatically changed from 02-22-chore_rivetkit_update_conns_to_be_hibernatable to main February 24, 2026 04:07
@railway-app railway-app bot temporarily deployed to rivet-frontend / rivet-pr-4256 February 24, 2026 04:08 Destroyed
@NathanFlurry NathanFlurry merged commit 112ef34 into main Feb 24, 2026
2 of 12 checks passed
@NathanFlurry NathanFlurry deleted the 02-21-docs_workflows branch February 24, 2026 04:08
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