docs: improve README structure with Docker-first quick start - #132
Merged
Conversation
…typos - Add Docker recommendation callout after tagline - Add Docker Quick Start section with minimal docker run command - Replace minimal config.yaml snippet with Docker reference and pointer to Config Reference - Reorder Docker Running section to show pull before build as primary path - Fix trailing double period in Docker SSH section - Fix YAML indentation in skill frontmatter example
- Use /tmp instead of tmp/ (absolute path, no trailing slash) - Remove ./ from sandbox paths - Move /tmp to the end of the paths list - Change memoryLimit from 512m to 128mb - Change maxReadSize from 1mb to 10mb
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.
Description
Restructure the README to present Docker as the recommended deployment path. Add a Docker Quick Start section in Quick Start with a minimal
docker runcommand, reference Docker for the full command with all optional environment variables, and point readers to the Config Reference table for all configuration options. Reorder the Docker Running section so pulling the prebuilt image is the primary path. Also fix a trailing double period in the Docker SSH section and a YAML indentation error in the skill frontmatter example.Type of Change
Testing
N/A - documentation-only change.
Coverage
Checklist