docs: shorten the README around the first workspace loop - #406
Merged
adrian-lorenzo merged 1 commit intoSep 24, 2026
Merged
adrian-lorenzo merged 1 commit into
adrian-lorenzo merged 1 commit into
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
adrian-lorenzo
approved these changes
Sep 24, 2026
adrian-lorenzo
merged commit Sep 24, 2026
5282fb0
into
codex/simplify-facility-readme
14 checks passed
3 tasks
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 free
to 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.
Change
Shorten the README to roughly 1,165 words and give first-time readers a three-step path: open the local application, prepare a repository, and run a story through the workspace loop. Detailed App permissions, authentication, configuration, troubleshooting, and CLI examples live in the linked guides.
The webhook example now requires a publicly reachable URL and points local development to a forwarding tunnel. The status copy is optimistic and concrete, while retaining migration guidance, maintainer access, merge policy, and budget behavior.
Review dependency
Stacked on #405 (
codex/simplify-facility-readme) so this diff contains only the follow-up refinements. After #405 lands, retarget this PR tomain.Validation
pnpm verifypassed lint, typecheck, and the clean monorepo build. It stopped before integration tests because host port 5461 was already allocated. The temporary test database resources were removed.verifyjob and minimum-Node compatibility check. Workspace E2E is skipped by the workflow's documentation-change policy.git diff --checkpasses. This PR changes only the README.