Skip to content

Commit 293ea82

Browse files
nk-agnk-ag
authored
Minor fixes in docs (#283)
* Enhance documentation and structure for Exosphere project - Added a new section on Open Source Commitment in README.md, outlining our dedication to the open source community. - Updated navigation in mkdocs.yml to reflect changes in documentation structure. - Expanded the Getting Started guide with detailed installation instructions, environment setup, and an overview of core concepts. - Introduced new logo assets for branding consistency. - Removed outdated files and streamlined content for clarity and better user experience. This update aims to improve accessibility and understanding of the Exosphere platform for new users and contributors. * Refactor README and documentation layout for improved clarity - Updated README.md to center-align badge links for better presentation. - Removed the "Star History" section from both README.md and index.md to streamline content. - Simplified logo display in index.md by removing unnecessary HTML structure. These changes enhance the overall readability and user experience of the documentation.
1 parent 6e22a24 commit 293ea82

2 files changed

Lines changed: 127 additions & 33 deletions

File tree

‎README.md‎

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
![logo light](assets/logo-light.svg#gh-light-mode-only)
22
![logo dark](assets/logo-dark.svg#gh-dark-mode-only)
33

4-
[![Docs](https://img.shields.io/badge/docs-latest-success)](https://docs.exosphere.host)
5-
[![Last commit](https://img.shields.io/github/last-commit/exospherehost/exospherehost)](https://github.com/exospherehost/exospherehost/commits/main)
6-
[![PyPI - Version](https://img.shields.io/pypi/v/exospherehost)](https://pypi.org/project/exospherehost/)
7-
[![Coverage](https://img.shields.io/codecov/c/gh/exospherehost/exospherehost)](https://codecov.io/gh/exospherehost/exospherehost)
8-
[![Kubernetes](https://img.shields.io/badge/Kubernetes-native-326ce5?logo=kubernetes&logoColor=white)](https://github.com/orgs/exospherehost/packages?repo_name=exospherehost)
9-
[![Discord](https://badgen.net/discord/members/V8uuA6mmzg)](https://discord.gg/V8uuA6mmzg)
10-
![Stars](https://img.shields.io/github/stars/exospherehost/exospherehost?style=social)
4+
<p align="center">
5+
<a href="https://docs.exosphere.host"><img src="https://img.shields.io/badge/docs-latest-success" alt="Docs"></a>
6+
<a href="https://github.com/exospherehost/exospherehost/commits/main"><img src="https://img.shields.io/github/last-commit/exospherehost/exospherehost" alt="Last commit"></a>
7+
<a href="https://pypi.org/project/exospherehost/"><img src="https://img.shields.io/pypi/v/exospherehost" alt="PyPI - Version"></a>
8+
<a href="https://codecov.io/gh/exospherehost/exospherehost"><img src="https://img.shields.io/codecov/c/gh/exospherehost/exospherehost" alt="Coverage"></a>
9+
<a href="https://github.com/orgs/exospherehost/packages?repo_name=exospherehost"><img src="https://img.shields.io/badge/Kubernetes-native-326ce5?logo=kubernetes&logoColor=white" alt="Kubernetes"></a>
10+
<a href="https://discord.gg/V8uuA6mmzg"><img src="https://badgen.net/discord/members/V8uuA6mmzg" alt="Discord"></a>
11+
<a href="https://github.com/exospherehost/exospherehost"><img src="https://img.shields.io/github/stars/exospherehost/exospherehost?style=social" alt="Stars"></a>
12+
</p>
1113

1214
---
1315

@@ -107,6 +109,17 @@ You can also visit the [official documentation site](https://docs.exosphere.host
107109

108110

109111

112+
## Open Source Commitment
113+
114+
We believe that humanity would not have been able to achieve the level of innovation and progress we have today without the support of open source and community, we want to be a part of this movement and support the open source community. In following ways:
115+
116+
1. We will be open sourcing majority of our codebase for exosphere.host and making it available to the community. We welcome all sort of contributions and feedback from the community and will be happy to collaborate with you.
117+
2. For whatever the profits which we generate from exosphere.host, we will be donating a portion of it to open source projects and communities. If you have any questions, suggestions or ideas.
118+
3. We would be further collaborating with various open source student programs to provide with the support and encourage and mentor the next generation of open source contributors.
119+
120+
Please feel free to reach out to us at [nivedit@exosphere.host](mailto:nivedit@exosphere.host). Lets push the boundaries of possibilities for humanity together!
121+
122+
110123
## Open Source Commitment
111124

112125
We believe that humanity would not have been able to achieve the level of innovation and progress we have today without the support of open source and community, we want to be a part of this movement and support the open source community. In following ways:
@@ -123,13 +136,5 @@ We welcome community contributions. For guidelines, refer to our [CONTRIBUTING.m
123136

124137
![exosphere.host Contributors](https://contrib.rocks/image?repo=exospherehost/exospherehost)
125138

126-
## Star History
127139

128-
<a href="https://www.star-history.com/#exospherehost/exospherehost&Date" target="_blank">
129-
<picture>
130-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date&theme=dark" />
131-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date" />
132-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date" />
133-
</picture>
134-
</a>
135140

‎docs/docs/index.md‎

Lines changed: 107 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
# Exosphere Docs
22

3-
<div align="center">
4-
5-
<picture>
6-
<source media="(prefers-color-scheme: dark)" srcset="./assets/logo-dark.svg">
7-
<source media="(prefers-color-scheme: light)" srcset="./assets/logo-light.svg">
8-
<img src="./assets/logo-light.svg" alt="Exosphere Logo">
9-
</picture>
10-
11-
</div>
123

134

145
Exosphere is an open-source infrastructure layer to run distributed AI workflows and agents with Python based on a node-based architecture.
@@ -147,6 +138,113 @@ Runtime(
147138

148139
The runtime will automatically reload and register the updated node.
149140

141+
### Create it
142+
143+
Create a file `main.py` with:
144+
145+
```python
146+
from exospherehost import Runtime, BaseNode
147+
from pydantic import BaseModel
148+
149+
class HelloWorldNode(BaseNode):
150+
class Inputs(BaseModel):
151+
name: str
152+
153+
class Outputs(BaseModel):
154+
message: str
155+
156+
class Secrets(BaseModel):
157+
pass
158+
159+
async def execute(self) -> Outputs:
160+
return self.Outputs(
161+
message=f"Hello, {self.inputs.name}!"
162+
)
163+
164+
# Initialize the runtime
165+
Runtime(
166+
namespace="MyProject",
167+
name="HelloWorld",
168+
nodes=[HelloWorldNode]
169+
).start()
170+
```
171+
172+
### Run it
173+
174+
Run the server with:
175+
176+
```bash
177+
uv run main.py
178+
```
179+
180+
### Check it
181+
182+
Your runtime is now running and ready to process workflows!
183+
184+
### Interactive Dashboard
185+
186+
Now go to your Exosphere dashboard to:
187+
188+
* View your registered nodes
189+
* Create and manage graph templates
190+
* Trigger workflows
191+
* Monitor execution states
192+
* Debug and troubleshoot
193+
194+
Ref: [Dashboard Guide](./exosphere/dashboard.md)
195+
196+
## Example flow
197+
198+
Now modify the file `main.py` to add more complex processing:
199+
200+
```python
201+
from exospherehost import Runtime, BaseNode
202+
from pydantic import BaseModel
203+
import json
204+
205+
class DataProcessorNode(BaseNode):
206+
class Inputs(BaseModel):
207+
data: str
208+
operation: str
209+
210+
class Outputs(BaseModel):
211+
result: str
212+
status: str
213+
214+
class Secrets(BaseModel):
215+
api_key: str
216+
217+
async def execute(self) -> Outputs:
218+
# Parse the input data
219+
try:
220+
data = json.loads(self.inputs.data)
221+
except:
222+
return self.Outputs(
223+
result="",
224+
status="error: invalid json"
225+
)
226+
227+
# Process based on operation
228+
if self.inputs.operation == "transform":
229+
result = {"transformed": data, "processed": True}
230+
else:
231+
result = {"original": data, "processed": False}
232+
233+
return self.Outputs(
234+
result=json.dumps(result),
235+
status="success"
236+
)
237+
238+
# Initialize the runtime
239+
Runtime(
240+
namespace="MyProject",
241+
name="DataProcessor",
242+
nodes=[DataProcessorNode]
243+
).start()
244+
```
245+
246+
The runtime will automatically reload and register the updated node.
247+
150248

151249
## Open Source Commitment
152250

@@ -164,13 +262,4 @@ We welcome community contributions. For guidelines, refer to our [CONTRIBUTING.m
164262

165263
![exosphere.host Contributors](https://contrib.rocks/image?repo=exospherehost/exospherehost)
166264

167-
## Star History
168-
169-
<a href="https://www.star-history.com/#exospherehost/exospherehost&Date" target="_blank">
170-
<picture>
171-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date&theme=dark" />
172-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date" />
173-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=exospherehost/exospherehost&type=Date" />
174-
</picture>
175-
</a>
176265

0 commit comments

Comments
 (0)