Repository navigation
docs(readme): restore platform rationale and a one-command quick start - #191
Conversation
Problem: The README says what SP42 is but never why it is built as platform plus domains, its Quick Start opens with a build step rather than a running app, and the Docker development section has an empty heading and two steps both titled "Build". Decision: Restore the "SP42 Challenges" section from an unpublished July README draft (commit a4450a3), updated to name the current domains; lead Quick Start with ./scripts/dev-local.sh --smoke; give the Docker development steps their own heading and retitle step 2 "Run". Rationale: The challenges text explains the per-wiki portability problem that motivates ADR-0013's layering. The rest of the draft is superseded by the current README, which is more accurate (all 20 crates, enforced layer placement, explicit SP42_DEPLOYMENT_MODE). Validation: ./scripts/check-doc-consistency.sh and ./scripts/check-links.sh pass; git diff --check is clean. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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. |
![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: 8ef2517d09
ℹ️ 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".
| ```sh | ||
| rustup target add wasm32-unknown-unknown | ||
| cargo install trunk | ||
| ./scripts/dev-local.sh --smoke |
There was a problem hiding this comment.
On a fresh checkout without the explicitly optional Wikimedia token, this command exits instead of leaving the advertised stack running: --smoke requests /operator/live/frwiki, that route returns 401 when neither a session nor local token exists, and curl -f under set -euo pipefail triggers the cleanup trap that kills both processes. Use plain ./scripts/dev-local.sh for the credential-free quick start, or limit the smoke check to public endpoints unless token setup is documented as required.
Useful? React with 👍 / 👎.
Summary
Restores the "SP42 Challenges" section from an unpublished July README draft (local commit
a4450a3c, never pushed), updated to name today's domains. It explains why SP42 is platform plus domains: per-wiki policies, templates and reviewer habits differ, and the goal is to make that portable without one-off apps per gate.Also:
./scripts/dev-local.sh --smoke(browser app + server in one command; the script setsSP42_DEPLOYMENT_MODE=localitself).####heading becomes "Docker Development Environment", and the second "Build the Docker Development Image" step is retitled "Run".The rest of the July draft is intentionally not restored: the current README is more accurate (all 20 crates, enforced layer placement, explicit
SP42_DEPLOYMENT_MODE).Type
Validation Required
check-focused.shnot run: README-only change.Risk
None checked: README only.
Notes For Reviewers
Once this lands, the local
feat/any-wiki-and-oauth-loginbranch holding the July draft is deleted; this PR is its only surviving content.🤖 Generated with Claude Code