-
Notifications
You must be signed in to change notification settings - Fork 121
chore(core): update docs #3074
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
chore(core): update docs #3074
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
How to use the Graphite Merge QueueAdd 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 encountered an error —— View job I'll analyze this and get back to you. |
commit: |
<Card title="Workflows" href="/docs/workflows" icon={faNodeJs}> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description for the Workflows card appears to be copied from the Actors card. It currently states "Set up actors with Node.js, Bun, and web frameworks" which doesn't accurately describe workflows functionality. Consider updating this text to properly reflect what workflows do and how they differ from actors.
<Card title="Workflows" href="/docs/workflows" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Workflows" href="/docs/workflows" icon={faNodeJs}> | |
Create and manage automated sequences of tasks and processes | |
</Card> | |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
<Card title="Agents" href="/docs/agents" icon={faNodeJs}> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description for the Agents card appears to be copied from the Actors card. It would be more helpful to provide a unique description that accurately explains what Agents are and their specific functionality, rather than repeating the text about setting up actors with Node.js, Bun, and web frameworks.
<Card title="Agents" href="/docs/agents" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Agents" href="/docs/agents" icon={faNodeJs}> | |
Create autonomous agents that can reason, plan, and execute tasks | |
</Card> | |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
site/src/content/docs/index.mdx
Outdated
<Card title="Stateful Workloads" href="/docs/workflows"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Realtime" href="/docs/agents"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Scalability" href="/docs/agents"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Multi-Region Storage" href="/docs/agents"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Architecture" href="/docs/actors"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The concept cards in this section all share the same description text: "Set up actors with Node.js, Bun, and web frameworks." This appears to be copy-pasted from the Actors card above, but doesn't accurately describe concepts like Scalability or Multi-Region Storage.
Additionally, several cards link to potentially incorrect documentation pages - for example, the "Stateful Workloads" card links to /docs/workflows
while "Architecture" links to /docs/actors
.
Each card should have:
- A unique description that accurately reflects its concept
- A link to the appropriate documentation page for that specific concept
This would improve the documentation's clarity and usefulness for users navigating the concepts section.
<Card title="Stateful Workloads" href="/docs/workflows"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Realtime" href="/docs/agents"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Scalability" href="/docs/agents"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Multi-Region Storage" href="/docs/agents"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Architecture" href="/docs/actors"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Stateful Workloads" href="/docs/stateful-workloads"> | |
Build reliable applications with durable state management | |
</Card> | |
<Card title="Realtime" href="/docs/realtime"> | |
Create responsive experiences with low-latency data synchronization | |
</Card> | |
<Card title="Scalability" href="/docs/scalability"> | |
Design systems that automatically scale with demand | |
</Card> | |
<Card title="Multi-Region Storage" href="/docs/storage"> | |
Distribute data globally for performance and reliability | |
</Card> | |
<Card title="Architecture" href="/docs/architecture"> | |
Understand the system design principles and components | |
</Card> |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
<Card title="Discord" href="/docs/actors"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="GitHub Issues" href="/docs/workflows"> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The support cards in this section appear to be using placeholder descriptions that were copied from the Actors section ("Set up actors with Node.js, Bun, and web frameworks"). Additionally, the href links may not be pointing to the correct external support resources.
Consider updating these cards with:
- Descriptions that accurately reflect what users can expect from each support channel
- Direct links to the Discord server and GitHub Issues page rather than documentation pages
For example:
<Card title="Discord" href="https://discord.com/invite/your-invite">
Join the community Discord for real-time support and discussions
</Card>
<Card title="GitHub Issues" href="https://github.com/your-org/your-repo/issues">
Report bugs or request features through GitHub Issues
</Card>
<Card title="Discord" href="/docs/actors"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="GitHub Issues" href="/docs/workflows"> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Discord" href="https://discord.com/invite/your-invite"> | |
Join the community Discord for real-time support and discussions | |
</Card> | |
<Card title="GitHub Issues" href="https://github.com/your-org/your-repo/issues"> | |
Report bugs or request features through GitHub Issues | |
</Card> | |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
901bebb
to
e410867
Compare
6124784
to
ce12053
Compare
Claude encountered an error —— View job I'll analyze this and get back to you. |
Claude encountered an error —— View job I'll analyze this and get back to you. |
ce12053
to
5af29cb
Compare
Claude encountered an error —— View job I'll analyze this and get back to you. |
5af29cb
to
e0e8129
Compare
Claude encountered an error —— View job I'll analyze this and get back to you. |
e0e8129
to
b1008bb
Compare
Claude encountered an error —— View job I'll analyze this and get back to you. |
<Card title="Agents" href="/docs/actors" icon={faNodeJs}> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Realtime" href="/docs/workflows" icon={faNodeJs}> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> | ||
<Card title="Durable Compute" href="/docs/agents" icon={faNodeJs}> | ||
Set up actors with Node.js, Bun, and web frameworks | ||
</Card> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The href attributes in the Use Cases section don't align with their card titles. Currently:
Agents
card links to/docs/actors
Realtime
card links to/docs/workflows
Durable Compute
card links to/docs/agents
Each card should link to its corresponding documentation page. Please update the href values to match their respective titles for proper navigation.
<Card title="Agents" href="/docs/actors" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Realtime" href="/docs/workflows" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Durable Compute" href="/docs/agents" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Agents" href="/docs/agents" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Realtime" href="/docs/realtime" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
<Card title="Durable Compute" href="/docs/durable-compute" icon={faNodeJs}> | |
Set up actors with Node.js, Bun, and web frameworks | |
</Card> | |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
No description provided.