From 540bced216962d77a92b7c973c1a8a2ae4808541 Mon Sep 17 00:00:00 2001 From: Ryan Dombrowski Date: Mon, 10 Aug 2026 15:16:57 -0400 Subject: [PATCH] docs: repair broken links, make the CLI runnable as documented, name the ecosystem MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Ecosystem documentation audit. This repo is deliberately paused, so the pass is limited to things that are broken or false — no rewrite of paused-product docs, no roadmap edits. - Three broken links: [CLAUDE.md] pointed at a file tracked as claude.md (works on macOS, 404 on GitHub); [.github/instructions/] had a leading slash that resolves to github.com's root, not the repo; and the clone command was the literal placeholder `git clone ` in both the README and the getting-started guide. - Every documented CLI example invokes a bare `af`, but the documented setup (`pnpm install`) never puts it on PATH — so none of them ran from a fresh clone. Added the build+link step, with the no-link alternative (`pnpm --filter @aesthetic-function/cli dev -- `) beside it. - The ecosystem pointer named three repos and framed dspack-studio as "hosted replay". It now names all six and leads with Composer, the current product, keeping the Studio as the replay exhibit. Co-Authored-By: Claude Opus 4.8 --- README.md | 11 +++++++---- docs/getting-started.md | 2 +- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 11553cb..91fb655 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ > Part of the [dspack ecosystem](https://github.com/aestheticfunction) — the organization profile has the full map of how the repositories fit together. > -> **Kind:** application (pnpm monorepo: CLI, server, watcher, Figma plugin) · **Audience:** teams keeping Figma, code, and docs aligned · **Neighbors:** reconciles against a committed [dspack](https://github.com/aestheticfunction/dspack) contract; a starting contract can be generated by [dspack-export](https://github.com/aestheticfunction/dspack-export); the generation-time half of the story lives in [dspack-studio](https://github.com/aestheticfunction/dspack-studio) ([hosted replay](https://studio.aesthetic-function.com)) +> **Kind:** application (pnpm monorepo: CLI, server, watcher, Figma plugin) · **Audience:** teams keeping Figma, code, and docs aligned · **Neighbors:** reconciles against a committed [dspack](https://github.com/aestheticfunction/dspack) contract; a starting contract can be generated by [dspack-export](https://github.com/aestheticfunction/dspack-export); the generation-time half of the story lives in [dspack-studio](https://github.com/aestheticfunction/dspack-studio) — its **Composer** ([composer.aesthetic-function.com](https://composer.aesthetic-function.com)) builds governed interfaces from a design system, with the Studio ([replay exhibit](https://studio.aesthetic-function.com)) alongside it — over [dspack](https://github.com/aestheticfunction/dspack) contracts, with [dspack-export](https://github.com/aestheticfunction/dspack-export) (discovery), [dspack-gen](https://github.com/aestheticfunction/dspack-gen) (generation + gates), [dspack-emit](https://github.com/aestheticfunction/dspack-emit) (emission), and [ds-mcp](https://github.com/aestheticfunction/ds-mcp) (contract-as-tools) > > **Status: paused.** Aesthetic Function's reconciliation/synchronization role remains part of the long-term ecosystem vision, but active development is intentionally deferred until there is demonstrated external adoption of the [dspack](https://github.com/aestheticfunction/dspack) contract and evidence that this additional capability is needed. The ecosystem's current focus is documentation, onboarding, and contract adoption. @@ -119,9 +119,12 @@ Three runtimes with strict boundaries: the **watcher** (reconciliation + analysi ### Install and Run ```bash -git clone +git clone https://github.com/aestheticfunction/aesthetic-function cd aesthetic-function pnpm install +pnpm --filter @aesthetic-function/cli build && pnpm link --global --filter @aesthetic-function/cli +# ^ puts `af` on your PATH. Without it, run the CLI as: +# pnpm --filter @aesthetic-function/cli dev -- [args] # Start the system pnpm dev:server # Terminal 1: relay server on :3001 @@ -183,9 +186,9 @@ For the full command set, see [docs/cli-reference.md](docs/cli-reference.md). | [docs/vue3-adapter.md](docs/vue3-adapter.md) | Contributors | Vue 3 SFC support, read-only status, marker syntax, Phase 3 write-back plan | | [docs/safety-and-control.md](docs/safety-and-control.md) | Contributors | Safety properties, CI gates, rollback model | | [docs/open-core.md](docs/open-core.md) | Everyone | Open core model, what is open, what may evolve | -| [CLAUDE.md](CLAUDE.md) | Claude AI | Project context for AI-assisted development | +| [claude.md](claude.md) | Claude AI | Project context for AI-assisted development | | [CONTRIBUTING.md](CONTRIBUTING.md) | Contributors | Test policy, code standards | -| [.github/instructions/](/.github/instructions/) | VS Code Copilot | Coding style, architecture rules | +| [.github/instructions/](.github/instructions/) | VS Code Copilot | Coding style, architecture rules | ## Open Core diff --git a/docs/getting-started.md b/docs/getting-started.md index ecd3baa..a40e3fa 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -11,7 +11,7 @@ This guide walks through setting up Aesthetic Function from a fresh clone to you ## 1. Install ```bash -git clone +git clone https://github.com/aestheticfunction/aesthetic-function cd aesthetic-function pnpm install ```