Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -119,9 +119,12 @@ Three runtimes with strict boundaries: the **watcher** (reconciliation + analysi
### Install and Run

```bash
git clone <repo-url>
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 -- <command> [args]

# Start the system
pnpm dev:server # Terminal 1: relay server on :3001
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide walks through setting up Aesthetic Function from a fresh clone to you
## 1. Install

```bash
git clone <repo-url>
git clone https://github.com/aestheticfunction/aesthetic-function
cd aesthetic-function
pnpm install
Comment on lines +14 to 16
```
Expand Down
Loading