docs: document zero-config standalone workflow#47
Conversation
✅ Deploy Preview for arashi-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d301519e99
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "validate:links:internal": "node scripts/check-internal-links.ts", | ||
| "validate:a11y": "pnpm build && node scripts/check-a11y-smoke.ts", | ||
| "validate:managed-ignore-docs": "pnpm sync:content && node scripts/check-managed-ignore-docs.ts", | ||
| "validate:standalone-docs": "pnpm sync:content && node scripts/check-standalone-docs.ts && node scripts/manual-bootstrap-selftest.mjs", |
There was a problem hiding this comment.
Adding validate:standalone-docs only to the aggregate pnpm validate does not make it run in the repository's PR/push validation: I checked .github/workflows/docs-validate.yml, and that workflow invokes the individual checks (lint, validate:build, internal links, a11y, managed-ignore, domain, README link) rather than pnpm validate, with no standalone-docs step. As a result, regressions in the new standalone workflow page or manual bootstrap block can still pass CI unless developers happen to run the aggregate script locally.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8a00e688e9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| assert.match( | ||
| readFileSync(join(root, ".git", "info", "exclude"), "utf8"), | ||
| /^\.worktrees\/$/m, | ||
| "success must add the repository-local exclude rule", |
There was a problem hiding this comment.
When a developer or runner has a global core.excludesFile that already ignores .worktrees/, the documented bootstrap correctly skips adding a repository-local rule, but this assertion still requires .git/info/exclude to contain it. I reproduced this by running the self-test with GIT_CONFIG_GLOBAL pointing to a config whose core.excludesFile contains .worktrees/; node scripts/manual-bootstrap-selftest.mjs fails before reaching the rest of the validation. The test should clear/isolate global Git config for its temp repos or assert the global-ignore case separately.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a368968cce
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## Agent Guidance | ||
|
|
||
| - Start by inspecting workspace state with \`arashi status\`. | ||
| - In a single repository, use \`arashi init --zero-config\` and the root \`.worktrees/<branch>\` convention; use ordinary \`arashi init\` for configured coordination. |
There was a problem hiding this comment.
For agents that consume /llms.txt, this now says to use arashi init --zero-config whenever they are in a single repository, which reverses the new user-facing guidance that configured mode is still preferred whenever a project can adopt Arashi, even for one repository. In that scenario an agent following the short export would skip .arashi/config.json, hooks, persisted defaults, and custom paths even though the project wanted Arashi configuration; the standalone wording should be limited to ad hoc/unconfigured projects.
Useful? React with 👍 / 👎.
1 participant
Implements the documentation portion of corwinm/arashi-arashi#212 under the OpenSpec proposal in corwinm/arashi-arashi#217.
Summary
arashi init --zero-configbootstrap and standalone lifecycle without exposing an implementation-detail shell procedureValidation
pnpm validatepassedRelated implementation
This child PR intentionally does not close the meta issue.