docs(readme): improve README with better structure, CLI reference, and cost model#3
Open
mayakost wants to merge 1 commit into
Conversation
…d cost model Add feature table, step-by-step quick-start with code snippets, CLI reference section, cost model table, and improved documentation index. Replace sparse prose sections with scannable tables and concrete examples so new users can go from zero to their first task submission faster. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Task-Id: 01KRGVPHMFB44ZCR5GGZ7EMG29 Prompt-Version: 1c9c10e027a2
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.
Summary
bgagentCLI reference section covering all commands and common optionsBuild and test results
Commands run:
mise run //docs:sync— ✅ passed (no stale mirrors)mise run build— ❌ pre-existing failure unrelated to this PR://agent:typecheckfails due tobotocore/boto3unresolved imports in the Python type checker (ty); this failure was present before any changes (confirmed in the task setup notes: "Initial build FAILED before agent changes"). The README change does not affect agent code, CDK, or CLI.Decisions made
docs/imgs/ABCA.pnglogo and architecture image (docs/imgs/abca-arch.png).Agent notes
What went well:
AGENTS.md,DEVELOPER_GUIDE.md,ARCHITECTURE.md,QUICK_START.md,ROADMAP.md) that made it straightforward to produce a well-informed README without guessing at capabilities.docs/guides/anddocs/design/— notREADME.md), so no regeneration was needed.What was difficult:
mise run buildhas pre-existing failures in//agent:typecheckdue to a Python type checker (ty) not findingboto3/botocoreeven though they are installed in the venv. This is a known environment issue that predates this PR.//docs:buildalso fails pre-existing (missingastrobinary), but the sync step (//docs:sync) that matters for CI succeeds.Patterns discovered:
MISE_EXPERIMENTAL=1is required for all namespacedmise //pkg:taskcommands.docs/src/content/docs/and must not be edited directly —docs/scripts/sync-starlight.mjsgenerates them fromdocs/guides/anddocs/design/.type(module): description(Conventional Commits) perCONTRIBUTING.md.Suggestions for future tasks:
//agent:typecheckfailure should be investigated — it appears to be atyconfiguration issue where the venv path is not being found correctly despite the packages being installed.//docs:buildfailure (missingastrobinary) suggestsyarn installmay not have run properly in thedocs/workspace in this environment.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the project license.