Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+655 −562
Open

chore(core): update docs #3074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion out/openapi.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

151 changes: 69 additions & 82 deletions site/next.config.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions site/public/llms-full.txt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions site/public/llms.txt
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 0 additions & 5 deletions site/src/app/(v2)/(content)/docs/page.tsx
View file
Open in desktop

This file was deleted.

53 changes: 53 additions & 0 deletions site/src/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
import { faNodeJs, faReact, faActor } from "@rivet-gg/icons";

# Overview

TODO: Brief overview

## Features

- Stateful Workloads: TODO
- Realtime: TODO
- Scalability: TODO
- Multi-Region Storage: TODO


## Tools

<CardGroup cols={2}>
<Card title="Actors" href="/docs/actors" icon={faNodeJs}>
Set up actors with Node.js, Bun, and web frameworks
</Card>
<Card title="Workflows" href="/docs/workflows" icon={faNodeJs}>
Set up actors with Node.js, Bun, and web frameworks
</Card>
Comment on lines +21 to +23
Copy link
Contributor

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.

Suggested change
<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

Fix in Graphite

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>
Comment on lines +24 to +26
Copy link
Contributor

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.

Suggested change
<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

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

</CardGroup>

## Use Cases

<CardGroup cols={2}>
<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>
Comment on lines +32 to +40
Copy link
Contributor

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.

Suggested change
<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

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

</CardGroup>

## Support

<CardGroup cols={2}>
<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>
Comment on lines +46 to +51
Copy link
Contributor

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:

  1. Descriptions that accurately reflect what users can expect from each support channel
  2. 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>
Suggested change
<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

Fix in Graphite

Is this helpful? React 👍 or 👎 to let us know.

</CardGroup>

Loading
Loading