docs: add 10-minute quickstart guide with 3 runnable examples#150
Merged
docs: add 10-minute quickstart guide with 3 runnable examples#150
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a dedicated quickstart entry point to help new users install contextweaver and run three end-to-end examples, and updates top-level docs to point to it and keep pipeline wording consistent.
Changes:
- Added
docs/quickstart.mdwith a 10-minute guide and 3 runnable examples (context build, firewall, routing). - Updated
README.mdto link prominently to the quickstart and corrected the pipeline stage count to eight. - Updated
CHANGELOG.mdunder[Unreleased]to note the new guide and README change.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/quickstart.md | New quickstart guide with install steps + runnable examples + next-step links. |
| README.md | Adds “10-Minute Quickstart” section and corrects pipeline stage count wording. |
| CHANGELOG.md | Documents the quickstart addition and README change under Unreleased. |
added 2 commits
March 21, 2026 06:22
Create docs/quickstart.md with prerequisites, install, three copy-paste examples (context build, firewall, routing), expected output excerpts, and next-step links. Update README.md with a prominent quickstart section and fix the context pipeline count from seven to eight stages.
- Add Windows ExecutionPolicy workaround note for venv activation - Fix firewall explanation to match actual apply_firewall() behavior - Use absolute GitHub URL for quickstart link (PyPI compatibility)
e5b415d to
187d641
Compare
- Revert quickstart link to relative path (no version drift) - Remove stale stage-count fix claim from changelog (already in main via #149)
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
Create a dedicated 10-minute quickstart guide so new users can install contextweaver, run three working examples, and see tangible output with copy-paste commands.
Fixes #76
Changes
docs/quickstart.md(new) — six-section quickstart guide:build_sync()→ prompt + stats)TreeBuilder→Router→ focused shortlist)README.md— added a prominent "10-Minute Quickstart" section linking to the new guide; fixed the context pipeline feature description from "seven-stage" to "eight-stage" (matchingAGENTS.mdand the actual pipeline)CHANGELOG.md— added entries under## [Unreleased]Checklist
make cipasses locally (fmt + lint + type + test + example + demo)makeunavailable on Windows; ran CI-equivalent commands individually:ruff format --check src/ tests/ examples/— 80 files already formattedruff check src/ tests/ examples/— all checks passedmypy src/— no issues in 41 source filespytest -q— 536 passedpython -m contextweaver demo— passedCHANGELOG.mdupdated under## [Unreleased]AGENTS.md,.github/copilot-instructions.md,.claude/CLAUDE.md— no updates needed. The quickstart is user-facing, and the "seven→eight" fix in README aligns it with whatAGENTS.mdalready documents.Notes for reviewers
pack.token_countandpack.budget, which do not exist onContextPack. The quickstart usespack.stats.*fields that actually exist. The issue also linked to future framework integration guides not yet authored — the quickstart links to existing docs instead and notes integrations as planned separately.source .venv/bin/activate(Linux/macOS) and.venv\Scripts\Activate.ps1(Windows PowerShell).