[PR #138] [MERGED] docs: audit and restructure README #138

New issue

Closed

opened 2026-08-22 07:31:55 +02:00 by zaph0d · 0 comments

zaph0d commented

2026-08-22 07:31:55 +02:00

Owner

📋 Pull Request Information

Original PR: https://github.com/niels-emmer/myace/pull/138
Author: @niels-emmer
Created: 8/21/2026
Status: ✅ Merged
Merged: 8/21/2026
Merged by: @niels-emmer

Base: main ← Head: docs/readme-audit

📝 Commits (1)

8049306 docs: audit and restructure README

📊 Changes

1 file changed (+55 additions, -100 deletions)

View changed files

📝 README.md (+55 -100)

📄 Description

Summary

Audit and restructure the README to reflect that MyACE now runs in production (hosted at myace.macjuu.com), not just as a self-hosted dev project.

What changed

Intro ("What it is") — added a live-instance mention and a metrics paragraph (19 starter collections, 210 artifacts, 8 categories, 102 tags, 12 target frameworks). Corrected the starter-pack counts: 8 categories and 102 tags, not the previously-stated 9 and 104 (verified against seed_collections.py and a tag count across collections/).
Features — rebuilt into five grouped themes (Compose & compile, Orchestrate, Community, CLI & automation, Auth & admin) capped at ten features. Folded in previously undocumented capabilities (TOTP two-factor auth, dark mode, documentation cache) and dropped lower-priority items to hit the max-10 target.
Architecture — removed the section entirely; it is fully covered by docs/architecture.md and docs/adapters-research.md.
License — moved to the bottom of the page.
Consistency — reconciled the "not run as someone else's SaaS" copy with the hosted instance.

Verification

Live instance confirmed reachable at myace.macjuu.com (demo compile endpoint returns valid output).
All internal doc links, anchors, and referenced files resolve.
Adapter count (12), CLI command count (9), and artifact counts verified against code.

Type of change

docs (documentation)

Testing

Manual: verified all internal links/anchors resolve; verified counts against code and the live site.

Checklist

Self-review completed
No new warnings
Documentation updated

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/niels-emmer/myace/pull/138 **Author:** [@niels-emmer](https://github.com/niels-emmer) **Created:** 8/21/2026 **Status:** ✅ Merged **Merged:** 8/21/2026 **Merged by:** [@niels-emmer](https://github.com/niels-emmer) **Base:** `main` ← **Head:** `docs/readme-audit` --- ### 📝 Commits (1) - [`8049306`](https://github.com/niels-emmer/myace/commit/8049306e7c41f7c12b7b1195246adae34be6b03a) docs: audit and restructure README ### 📊 Changes **1 file changed** (+55 additions, -100 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+55 -100) </details> ### 📄 Description ## Summary Audit and restructure the README to reflect that MyACE now runs in production (hosted at myace.macjuu.com), not just as a self-hosted dev project. ### What changed - **Intro ("What it is")** — added a live-instance mention and a metrics paragraph (19 starter collections, 210 artifacts, 8 categories, 102 tags, 12 target frameworks). Corrected the starter-pack counts: **8 categories and 102 tags**, not the previously-stated 9 and 104 (verified against `seed_collections.py` and a tag count across `collections/`). - **Features** — rebuilt into five grouped themes (Compose & compile, Orchestrate, Community, CLI & automation, Auth & admin) capped at ten features. Folded in previously undocumented capabilities (TOTP two-factor auth, dark mode, documentation cache) and dropped lower-priority items to hit the max-10 target. - **Architecture** — removed the section entirely; it is fully covered by `docs/architecture.md` and `docs/adapters-research.md`. - **License** — moved to the bottom of the page. - **Consistency** — reconciled the "not run as someone else's SaaS" copy with the hosted instance. ### Verification - Live instance confirmed reachable at myace.macjuu.com (demo compile endpoint returns valid output). - All internal doc links, anchors, and referenced files resolve. - Adapter count (12), CLI command count (9), and artifact counts verified against code. ## Type of change - [x] docs (documentation) ## Testing - Manual: verified all internal links/anchors resolve; verified counts against code and the live site. ## Checklist - [x] Self-review completed - [x] No new warnings - [x] Documentation updated --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

zaph0d

2026-08-22 07:31:55 +02:00