Skip to content

Commit 8bb2c0f

Browse files
baijumclaude
andcommitted
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>
1 parent 3892fc4 commit 8bb2c0f

2 files changed

Lines changed: 23 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Project Overview
44

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.
66

77
## Repository Structure
88

@@ -17,6 +17,19 @@ docs/ # All documentation (Markdown)
1717
ecosystem.md # Org structure, app template, multi-app hosting
1818
governance.md # Repository governance policies
1919
roadmap.md # Phased development plan
20+
tutorial.md # Step-by-step deployment walkthrough
21+
server-contract.md # Platform-to-workflow interface contract
22+
infrastructure/ # Server bootstrap and ops scripts
23+
bootstrap-server.sh # Debian 12 -> running platform (idempotent)
24+
verify-server.sh # Read-only server health check
25+
create-app-credentials.sh # Per-app DB/S3 credential provisioning
26+
check-alerts.sh # Cron health checker -> GitHub Issues
27+
backup-postgres.sh # Daily per-database pg_dump
28+
restore-postgres.sh # Restore from backup
29+
update-images.sh # Weekly Docker image pull + recreate
30+
usage-report.sh # Resource usage report
31+
validator/
32+
validate.py # Spec conformance validator (tiers 1-3)
2033
scripts/
2134
setup-repo.sh # GitHub repo governance setup script
2235
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
3447
- **Self-hosting**: Users fork a repo, configure GitHub secrets, push, and the app deploys
3548
- **Multi-app**: One server hosts multiple apps via subdomain routing through Caddy
3649
- **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
3752

3853
## Working With This Repo
3954

40-
### Documentation Only
55+
### Documentation and Infrastructure
4156

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.
4358

4459
### Local Preview
4560

@@ -76,3 +91,5 @@ Site serves at `http://127.0.0.1:8000` with auto-reload.
7691
- **Adding a new documentation page**: Create a `.md` file in `docs/`, then add it to the `nav` section in `mkdocs.yml`
7792
- **Updating the spec**: Edit `docs/spec.md` — ensure changes are consistent with `architecture.md` and `deployment.md`
7893
- **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

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,12 @@ Full documentation is available at **[towlion.github.io/platform](https://towlio
1515
- [Preview Environments](https://towlion.github.io/platform/preview-environments/) — PR previews, DNS, cleanup
1616
- [Ecosystem](https://towlion.github.io/platform/ecosystem/) — org structure, app template, multi-app hosting
1717
- [Roadmap](https://towlion.github.io/platform/roadmap/) — phased development plan
18+
- [Tutorial](https://towlion.github.io/platform/tutorial/) — step-by-step deployment walkthrough
19+
- [Server Contract](https://towlion.github.io/platform/server-contract/) — platform-to-workflow interface
1820

1921
## Project Status
2022

21-
Early development. The platform is evolving toward a fully automated GitHub-driven deployment ecosystem.
23+
Phases 1–6 complete. The platform provides a fully automated GitHub-driven deployment ecosystem with infrastructure bootstrap, multi-app hosting, observability, and self-hosting support. Awaiting external validation.
2224

2325
## License
2426

0 commit comments

Comments
 (0)