Skip to content

Docs/0.0.2 #355

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

Merged
nk-ag merged 3 commits into from
Sep 4, 2025
Merged

Docs/0.0.2 #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89b6a2d
v0.0.2 docs
nk-ag Sep 4, 2025
4d7f549
color fixes
nk-ag Sep 4, 2025
249d970
spell check
nk-ag Sep 4, 2025
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
32 changes: 11 additions & 21 deletions docs/docs/docker-compose-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,16 @@ After running the Docker Compose command:
- **MongoDB** (if using with-mongodb): `mongodb://localhost:27017` (not HTTP - use MongoDB clients like MongoDB Compass or mongosh)
- **API Documentation**: `http://localhost:8000/docs`

## Next Steps

Now that your Exosphere services are running, continue with these guides:

- **[Create a Node](./exosphere/register-node.md)** – Learn how to define and register your own node.
- **[Create a Runtime](./exosphere/create-runtime.md)** – Set up and configure your runtime environment.
- **[Create a Graph](./exosphere/create-graph.md)** – Build workflows by connecting nodes together.
- **[Trigger a Graph](./exosphere/trigger-graph.md)** – Execute your workflows and monitor their progress.


Comment on lines +122 to +131
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick (assertive)

Nice “Next Steps” block; minor copy polish.

Consider consistent capitalization for MongoDB elsewhere (“MongoDB” vs “Mongodb”) and vary sentence starts (“Create …”) for style, but content LGTM.

🧰 Tools
🪛 LanguageTool

[grammar] ~122-~122: Use correct spacing
Context: ...tp://localhost:8000/docs` ## Next Steps Now that your Exosphere services are run...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

[grammar] ~124-~124: Use correct spacing
Context: ...are running, continue with these guides: - **[Create a Node](./exosphere/register-node...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

[grammar] ~126-~126: Make sure you are using the right part of speech
Context: ...e with these guides: - Create a Node – Learn how to define and register your own nod...

(QB_NEW_EN_OTHER_ERROR_IDS_21)

[grammar] ~126-~126: There might be a mistake here.
Context: ...ow to define and register your own node. - **[Create a Runtime](./exosphere/create-run...

(QB_NEW_EN)

[style] ~128-~128: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...onfigure your runtime environment. - Create a Graph...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

[grammar] ~128-~128: There might be a mistake here.
Context: ...runtime environment. - Create a Graph – Build workflows by connecting nodes together....

(QB_NEW_EN_OTHER)

[grammar] ~128-~128: There might be a mistake here.
Context: ... workflows by connecting nodes together. - **[Trigger a Graph](./exosphere/trigger-gra...

(QB_NEW_EN)

[grammar] ~129-~129: Make sure you are using the right part of speech
Context: ...ing nodes together. - Trigger a Graph – Execute your workflows and monitor their progre...

(QB_NEW_EN_OTHER_ERROR_IDS_21)

[grammar] ~129-~129: Use correct spacing
Context: ...ur workflows and monitor their progress. ## Development Commands === "Cloud Mongodb...

(QB_NEW_EN_OTHER_ERROR_IDS_5)

🤖 Prompt for AI Agents 
In docs/docs/docker-compose-setup.md around lines 122 to 131, the "Next Steps"
block needs minor copy polishing: ensure consistent capitalization for MongoDB
across the docs (use "MongoDB" not "Mongodb") and vary the sentence starters in
the bullet list (avoid repeating "Create ...") by rewording some items to use
alternative verbs or phrasings while keeping links and targets unchanged.

## Development Commands

=== "Cloud Mongodb"
Expand Down Expand Up @@ -257,6 +267,7 @@ You can validate your docker-compose configuration before starting services:
| `NEXT_PUBLIC_DEFAULT_NAMESPACE` | Default namespace for workflows | `default` |

> **🔒 Security Note**: The dashboard now uses **Server-Side Rendering (SSR)** for enhanced security:
>
> - **API keys are never exposed** to the browser
> - **All API calls go through** secure server-side routes
> - **Production-ready security** architecture
Expand Down Expand Up @@ -458,27 +469,6 @@ alias 'docker compose'='docker-compose'

4. **SDK connection issues**: Make sure `EXOSPHERE_STATE_MANAGER_URI` points to the correct URL and `EXOSPHERE_API_KEY` matches your `STATE_MANAGER_SECRET`. The `EXOSPHERE_API_KEY` value is checked for equality with the `STATE_MANAGER_SECRET` value when making API requests.

## Next Steps

Once your Exosphere instance is running:

1. **Set up your SDK environment variables**:
```bash
export EXOSPHERE_STATE_MANAGER_URI=http://localhost:8000
export EXOSPHERE_API_KEY=exosphere@123
```

2. **Install the Python SDK**:
```bash
uv add exospherehost
```

3. **Create your first workflow** following the [Getting Started Guide](https://docs.exosphere.host/getting-started)

4. **Explore the dashboard** at `http://localhost:3000`

5. **Check out the API documentation** at `http://localhost:8000/docs`

## Support

- [Documentation](https://docs.exosphere.host)
Expand Down
189 changes: 0 additions & 189 deletions docs/docs/exosphere/api-changes.md
View file
Open in desktop

This file was deleted.

Loading