Conversation
How to use the Graphite Merge QueueAdd the label graphite/merge 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. |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
ryanditjia
left a comment
ryanditjia
left a comment
There was a problem hiding this comment.
Some of the review comments are more questions rather than request changes.
I didn’t review: forge and the client SDK dropdowns.
Also raised a PR for changes that I think makes sense: #855
|
|
||
| ### Personas | ||
|
|
||
| A persona is the unique identity associated with a player’s account. All commands include metadata containing the sender’s persona, which you can use for authorization checks like verifying entity ownership. |
There was a problem hiding this comment.
If one reads the docs starting from Introduction and follow the Next buttons, one doesn’t get introduced to anything that leads to Persona, therefore Persona/account/authorization feel foreign, with no link to learn more. Perhaps a <Tip> or <Note> could help here.
There was a problem hiding this comment.
Makes sense. I wanted to add a section to explain Cardinal's architecture more, but I'm not sure where to put it in. The "the world" section at the top of the ECS page was originally supposed to be here in a "introduction" page, but I feel that going to ECS first is better to get readers more hands-on/involved (e.g. they can try on their own while reading) vs putting an introduction/architecture page first that is heavy on theory will be too "academic"(?). academic isn't the right word but I'm not sure how best to describe it. Going straight to ECS is more "quick-starty" than learning the high-level architecture as that can be learned later.
There was a problem hiding this comment.
I’m thinking:
- Cardinal
- ECS
- Persona (Game Account) <-- add this doc
- Commands
- Events
And this Persona doc is a rather short intro which briefly mentions:
- How game engines are incomplete without some sort of auth
- Personas are game accounts, how the string looks like
- Local dev uses DevAuth
- Staging (dev) uses Argus Auth
Wdyt? If okay, I’ll attempt this, since I’m more familiar with the Unity code.
There was a problem hiding this comment.
The contents sounds good. After some thinking, we should move the persona page into a "introduction" page before ECS, which also introduces the shard concept and auth+personas. That way, we can get rid of the "client integration" page since every aspect of the client integration has been covered.
| Use `SendCommand` to dispatch a command to another shard. Pass the system's `BaseSystemState` and the command you want to send: | ||
|
|
||
| ```go | ||
| import matchcmd "my-game/shards/matchmaking/command" |
There was a problem hiding this comment.
cmiiw, but shouldn’t this be in the pkg folder?
There was a problem hiding this comment.
it doesn't have to be.
2 participants
TL;DR
Update Cardinal-related pages.
Questions
How to test
Run
mintlify devin thedocs/folder to run the docs site locally.