Uh oh!
There was an error while loading. Please reload this page.
docs: repair broken links, make the CLI runnable as documented, name the ecosystem - #7
Merged
Merged
Conversation
…the ecosystem 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 <repo-url>` 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 -- <command>`) 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 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Documentation-only maintenance pass to fix broken links and align setup instructions with how the monorepo’s CLI is actually executed after a fresh clone, while also updating the “ecosystem” pointer to reflect current related repos/products.
Changes:
- Fix broken/incorrect links in
README.md(case-sensitiveclaude.md, and repo-relative.github/instructions/). - Replace placeholder clone commands with a real clone URL in
README.mdanddocs/getting-started.md. - Add CLI build + global link instructions (and a no-link alternative) to the
README.mdQuick Start; expand the ecosystem description to name additional repos and Composer/Studio URLs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Repairs broken links, updates clone/setup steps so af can be runnable as documented, and expands ecosystem naming/pointers. |
| docs/getting-started.md | Replaces placeholder clone command with the real repository URL. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+14
to
16
| git clone https://github.com/aestheticfunction/aesthetic-function | ||
| cd aesthetic-function | ||
| pnpm install |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
From an ecosystem-wide documentation audit. This repo is deliberately paused, so this pass is limited to what is broken or false — no rewrite of paused-product docs, no roadmap edits, placeholders left as placeholders.
[CLAUDE.md](CLAUDE.md)→ the tracked file isclaude.md(resolves on macOS, 404 on GitHub);[.github/instructions/](/.github/instructions/)→ the leading slash resolves to github.com's root, not the repo; and the clone command was the literal placeholdergit clone <repo-url>in both README and getting-started.af, but the documented setup is onlypnpm install— no link step, no global install. Added the build+link step and the no-link alternative (pnpm --filter @aesthetic-function/cli dev -- <command>).Deliberately not touched: the paused status, phase-numbered internal docs, the four self-declared placeholder docs, and the reconciliation-loop diagrams (accurate for this repo's own subject).
🤖 Generated with Claude Code