Refactor documentation to position Pocket as CLI-first graph execution engine #13
Conversation
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
- Rewrite main README.md to prioritize CLI usage - Create dedicated /docs/cli/ directory with comprehensive CLI docs - Create /docs/library/ for Go library documentation - Create /docs/nodes/ for node type documentation - Create /docs/workflows/ for example workflows - Create /docs/development/ for contributors - Position Pocket as a graph execution engine for LLM workflows This restructuring makes the CLI the primary entry point while maintaining excellent documentation for Go developers. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Major documentation overhaul to reposition Pocket as a graph execution engine for LLM workflows, with CLI as the primary use case and Go library as secondary. Documentation Changes: - Restructured README.md with CLI-first approach - Created comprehensive CLI documentation suite in docs/cli/ - Reorganized library docs to docs/library/ as secondary use case - Added workflow examples organized by complexity (basic/advanced/real-world) - Updated all concept docs to emphasize 'graph execution engine' positioning - Fixed all API examples to use new Steps struct pattern - Added language-agnostic plugin examples (Lua, WASM, Native) Release System: - Added GoReleaser configuration for multi-platform builds - Set up automated release workflow with GitHub Actions - Configured Homebrew formula with dual installation support: - Pre-built binaries (bottles) by default - Source builds with --build-from-source flag - Added install.sh script for quick installation - Created RELEASING.md with maintainer documentation Key Features: - Builds for 8 platform/architecture combinations - SHA256 checksums for all releases - Automatic Homebrew tap updates - Comprehensive changelog generation - Draft releases with proper versioning This positions Pocket following best practices from tools like kubectl, terraform, and docker, making it more accessible to the broader developer community beyond just Go developers.
Codecov ReportAll modified and coverable lines are covered by tests ✅ ❌ Your project status has failed because the head coverage (40.86%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage. @@ Coverage Diff @@
## master #13 +/- ##
=======================================
Coverage 40.86% 40.86%
=======================================
Files 39 39
Lines 7393 7393
=======================================
Hits 3021 3021
Misses 4221 4221
Partials 151 151
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
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
This PR implements a comprehensive documentation refactor to reposition Pocket as a graph execution engine for LLM workflows, with the CLI as the primary use case and the Go library as secondary.
Key Changes
🎯 Documentation Restructuring
pocket.Steps{}struct pattern📁 New Documentation Structure
🚀 Release Automation
--build-from-sourceflag📦 Installation Methods
brew install agentstation/tap/pocketcurl -sSL .../install.sh | bashgo install github.com/agentstation/pocket/cmd/pocket@latestTesting
The new release system includes:
Migration Impact
Zero breaking changes - All existing code continues to work. The changes are purely organizational and additive.
Next Steps
After merging, we should:
cli,workflow-engine,llm,graph,yaml,lua,wasmRelated Documentation
This refactor positions Pocket alongside tools like kubectl, terraform, and docker - making it accessible to the broader developer community beyond just Go developers.