Skip to content
This repository was archived by the owner on Nov 4, 2026. It is now read-only.

Commit 6112e0d

Browse files
baozhoutaoclaude
andauthored
docs(setup): point setup.sh's third "Next steps" read at a doc that exists (#8982)
* docs(setup): point setup.sh's third "Next steps" read at a doc that exists `scripts/setup.sh`'s "Next steps" block told every new contributor to read `ARCHITECTURE_EVALUATION.md`. That file is not tracked: it was added in 63c106b and deliberately deleted as obsolete in ea72f18, but this line was never updated with it. The block's other two targets (`README.md`, `CONTRIBUTING.md`) both resolve, so this is one dangling pointer, not a broken block. Repointed at `content/docs/guide/architecture.md` on a stated criterion: step 3 of a numbered reading list must be an orientation document for a contributor to this monorepo, and `CONTRIBUTING.md` -- the file at step 2 of this very block -- already designates exactly one architecture document as the continuation of its own architecture section. Pointing step 3 at the same file keeps the block a single route instead of adding a fourth. Rejected candidates and why: - content/docs/guide/architecture-overview.md -- self-described "Deep dive"; sections are anchored to individual implementation files and it ends in a "Key Directories Reference". Reference material, not the third read; it is also already what README.md (step 1) hands off to. - content/docs/guide/console-architecture.md -- scoped to the internals of one app (the console SPA), as its own first line says. - docs/ARCHITECTURE.md -- "Console Streamlining - Architecture Guide", a record of one refactoring project. - skills/objectui/guides/architecture.md -- written for consumers of the published @object-ui/* packages, not for contributors to this repo. No changeset: check-changeset-presence.mjs reports none is owed. Co-authored-by: Claude Claude-Session: https://claude.ai/code/session_01FhBNJcLRZLe8M87VcUgpKr * docs(setup): repoint line 130 at docs/ARCHITECTURE.md, triage's ruled target Supersedes the target chosen in the previous commit on this branch. The defect and its repair are unchanged -- line 130 named the untracked ARCHITECTURE_EVALUATION.md -- only the replacement target moves, from content/docs/guide/architecture.md to docs/ARCHITECTURE.md. Triage had already taken this decision explicitly, as a non-escalating documentation-wording call. The protocol for a contrary fact found while implementing a ruling's ordered action is to execute the action literally and file the fact, never to substitute a different answer: the analysis that argues for a different target is preserved in the PR body and is being raised as an objection on the card, which stays open. Acceptance probe, one run, positive and negative controls: git ls-files --error-unmatch docs/ARCHITECTURE.md -> exit=0 git ls-files --error-unmatch ARCHITECTURE_EVALUATION.md -> exit=1 git ls-files --error-unmatch package.json -> exit=0 control+ git ls-files --error-unmatch NO_SUCH_FILE_XYZ.md -> exit=1 control- Gates re-run because the line changed again: check-bash32-floor 0, check-doc-links 0, check-shell-escape-residue 0, check-control-bytes 0, check-changeset-presence 0 (none owed), lint:root 0, bash -n 0, bash32-floor-wiring 9/9. Co-authored-by: Claude Claude-Session: https://claude.ai/code/session_01FhBNJcLRZLe8M87VcUgpKr --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent ca67d42 commit 6112e0d

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎scripts/setup.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ echo -e " ${GREEN}pnpm create-plugin${NC} - Create a new plugin\n"
127127
echo -e "${BLUE}Next steps:${NC}"
128128
echo -e " 1. Read ${GREEN}README.md${NC} for project overview"
129129
echo -e " 2. Read ${GREEN}CONTRIBUTING.md${NC} for contribution guidelines"
130-
echo -e " 3. Read ${GREEN}ARCHITECTURE_EVALUATION.md${NC} for architecture insights"
130+
echo -e " 3. Read ${GREEN}docs/ARCHITECTURE.md${NC} for architecture insights"
131131
echo -e " 4. Run ${GREEN}pnpm dev${NC} to start coding!\n"
132132

133133
echo -e "${BLUE}Happy coding! 🎉${NC}\n"

0 commit comments

Comments
 (0)