Updated Aquila Docs#300
Conversation
GitLab Pipeline ActionGeneral informationLink to pipeline: https://gitlab.com/code0-tech/development/aquila/-/pipelines/2479611588 Status: Passed Job summariesdocs:previewDocumentation preview available at https://code0-tech.gitlab.io/-/development/telescopium/-/jobs/14089445841/artifacts/out/index.html |
b3ef5e6 to
8d321a2
Compare
|
Any ideas what's missing/could be done better? @Taucher2003 @nicosammito |
There was a problem hiding this comment.
Pull request overview
Updates Aquila’s documentation to better explain the runtime/service architecture (including Actions and service authorization structure) and slightly improves Sagittarius connection observability/readiness signaling.
Changes:
- Expanded docs with setup/configuration details (env vars, service configuration file structure) and architecture diagrams for static vs. dynamic operation.
- Updated the default
service.configuration.jsoncontent to an emptyactionslist and a populatedruntimeslist. - Improved Sagittarius channel connection behavior by setting readiness on successful connect and logging successful connections.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/sagittarius/retry.rs | Marks Sagittarius readiness on successful connect and adds a success log line. |
| service.configuration.json | Replaces prior example action config with a runtime token list (now the default config content). |
| docs/index.mdx | Refreshes landing page wording and adds links to setup/dev guides. |
| docs/Guides/setup.md | Major expansion: setup modes, env var tables, and service configuration file explanation/examples. |
| docs/Guides/dev.md | Adds runtime infrastructure overview and mermaid diagrams; explains static vs dynamic concepts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Maybe you could use the Steps, Step component from fumadocs to show the user how to setup Aquila for dev and prod. I would also rename the pages to "Installation" and also "Development" and remove the grouping "Guides". |
Resolves: #269