📝 docs: rewrite README microsandbox-style, relocate marketing content#1345
Open
roninjin10 wants to merge 1 commit into
Open
📝 docs: rewrite README microsandbox-style, relocate marketing content#1345roninjin10 wants to merge 1 commit into
roninjin10 wants to merge 1 commit into
Conversation
Lean, command-first README: logo banner, centered badges, feature list, requirements note, and a CLI cheat sheet. The when-to-use table moves to guide/what-is-smithers; the self-orchestration comparison and the 100+ patterns card drop from the README (the docs landing already carries them). Adds CONTRIBUTING.md, realigns the check-docs README needles, and fixes the stale readme-contract test. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
❌ smithers review failed: 2 file reviews failed — run |
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
1 participant
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.
Restructures the README along the lines of microsandbox's (lean, visual, command-first) while keeping everything load-bearing: both product GIFs, the Monitor screenshot, the workflow code example, the mental-model loop, and the CLI cheat sheet.
README
<Loop>primitive table, the triple "former starters" repetition (one mention remains, in Examples), and the quickstart command that required a manual copy step first.bunx smithers-orchestratorform (normalize-bunx gates this; baresmithersis a different npm package).Docs
docs/guide/what-is-smithers.mdx(not in the llms manifest, so no bundle regen).Gates
scripts/check-docs.mjs: the README needle set required the exact orphaned table row; it now requires the<Loop until=...>code example instead, still forbidding Ralph/Studio strings.scripts/readme-contract.test.mjs: was stale (expected an image alt and a Loop form the README no longer had); realigned with the current content. Passes underbun test.CONTRIBUTING.mdlinked from the README: setup, CI gates, and the repo invariants.pnpm check:docsexits 0.🤖 Generated with Claude Code