This page is the primary entry point for the documentation system.
Last refreshed: February 21, 2026.
Localization index: i18n/README.md.
| I want to… | Read this |
|---|---|
| Install and run Gloamy quickly | README.md (Quick Start) |
| Understand the full feature set | feature-overview.md |
| Bootstrap in one command | one-click-bootstrap.md |
| Update or uninstall on macOS | getting-started/macos-update-uninstall.md |
| Find commands by task | commands-reference.md |
| Check config defaults and keys quickly | config-reference.md |
| Configure custom providers/endpoints | custom-providers.md |
| Configure Z.AI / GLM provider | zai-glm-setup.md |
| Use LangGraph integration patterns | langgraph-integration.md |
| Operate runtime (day-2 runbook) | operations-runbook.md |
| Troubleshoot install/runtime/channel issues | troubleshooting.md |
| Run Matrix encrypted-room setup and diagnostics | matrix-e2ee-guide.md |
| Browse docs by category | SUMMARY.md |
| See project PR/issue docs snapshot | project-triage-snapshot-2026-02-18.md |
- Need first-time setup or install? → getting-started/README.md
- Need exact CLI/config keys? → reference/README.md
- Need production/service operations? → operations/README.md
- Seeing failures or regressions? → troubleshooting.md
- Working on security hardening or roadmap? → security/README.md
- Working with boards/peripherals? → hardware/README.md
- Contributing/reviewing/CI workflow? → pr-workflow.md
- Want the full map? → SUMMARY.md
- Getting started: getting-started/README.md
- Reference catalogs: reference/README.md
- Feature overview: feature-overview.md
- Operations & deployment: operations/README.md
- Security docs: security/README.md
- Hardware/peripherals: hardware/README.md
- Contributing/CI: pr-workflow.md
- Project snapshots: project/README.md
- commands-reference.md — command lookup by workflow
- providers-reference.md — provider IDs, aliases, credential env vars
- channels-reference.md — channel capabilities and setup paths
- matrix-e2ee-guide.md — Matrix encrypted-room (E2EE) setup and no-response diagnostics
- config-reference.md — high-signal config keys and secure defaults
- custom-providers.md — custom provider/base URL integration templates
- zai-glm-setup.md — Z.AI/GLM setup and endpoint matrix
- langgraph-integration.md — fallback integration for model/tool-calling edge cases
- operations-runbook.md — day-2 runtime operations and rollback flow
- troubleshooting.md — common failure signatures and recovery steps
Note: this area includes proposal/roadmap docs. For current behavior, start with config-reference.md, operations-runbook.md, and troubleshooting.md.
- security/README.md
- agnostic-security.md
- frictionless-security.md
- sandboxing.md
- audit-logging.md
- resource-limits.md
- security-roadmap.md
- Unified TOC: SUMMARY.md
- Docs structure map (language/part/function): structure/README.md
- Documentation inventory/classification: docs-inventory.md
- i18n docs index: i18n/README.md
- Project triage snapshot: project-triage-snapshot-2026-02-18.md