You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update AGENTS.md and README.md for Phase 6 completeness
Add infrastructure scripts, validator, and new docs to AGENTS.md
repo structure. Update project status from early development to
Phases 1-6 complete. Add tutorial and server contract doc links.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: AGENTS.md
+20-3Lines changed: 20 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Project Overview
4
4
5
-
This is the **Towlion Platform** repository — a documentation-only repo that defines the architecture, specifications, and guides for a self-hosted GitHub-native micro-PaaS. There is no runnable application code in this repository; it contains only Markdown documentation and MkDocs configuration.
5
+
This is the **Towlion Platform** repository — a spec-and-infrastructure repo that defines the architecture, specifications, infrastructure scripts, and guides for a self-hosted GitHub-native micro-PaaS. There is no runnable application code in this repository; it contains documentation, a spec validator, and server automation scripts.
6
6
7
7
## Repository Structure
8
8
@@ -17,6 +17,19 @@ docs/ # All documentation (Markdown)
labels.json # Standard labels for app repos (used by setup-repo.sh)
@@ -34,12 +47,14 @@ Towlion is a single-server micro-PaaS where GitHub acts as the control plane. Ke
34
47
-**Self-hosting**: Users fork a repo, configure GitHub secrets, push, and the app deploys
35
48
-**Multi-app**: One server hosts multiple apps via subdomain routing through Caddy
36
49
-**App contract**: Backend on port 8000, `GET /health` endpoint, env-var configuration, PostgreSQL + Alembic migrations
50
+
-**Infrastructure automation**: Idempotent server bootstrap, per-app credential provisioning, backups, alerting, and image updates
51
+
-**Self-hosting env vars**: `ACME_EMAIL` (TLS certs), `OPS_DOMAIN` (Grafana route), `ALERT_REPO` (GitHub issue alerts) — all optional with sensible defaults
37
52
38
53
## Working With This Repo
39
54
40
-
### Documentation Only
55
+
### Documentation and Infrastructure
41
56
42
-
All content is Markdown in `docs/`. There are no tests, no build steps, and no application code to run. Changes should focus on clarity, accuracy, and consistency across documents.
57
+
Documentation is in `docs/`, infrastructure scripts are in `infrastructure/`, and the spec validator is in `validator/`. There is no application code to run. Changes to docs should focus on clarity, accuracy, and consistency across documents.
43
58
44
59
### Local Preview
45
60
@@ -76,3 +91,5 @@ Site serves at `http://127.0.0.1:8000` with auto-reload.
76
91
-**Adding a new documentation page**: Create a `.md` file in `docs/`, then add it to the `nav` section in `mkdocs.yml`
77
92
-**Updating the spec**: Edit `docs/spec.md` — ensure changes are consistent with `architecture.md` and `deployment.md`
78
93
-**Modifying site config**: Edit `mkdocs.yml` for theme, navigation, or extension changes
94
+
-**Running the spec validator**: `python validator/validate.py <path-to-app-repo>` — checks conformance at tiers 1-3
95
+
-**Modifying infrastructure scripts**: Edit files in `infrastructure/` — all scripts must pass `shellcheck` with zero warnings
0 commit comments