docs: add quick-start and comparison pages - #12
Merged
Merged
Conversation
API-verified against v0.5.3. Adds docs/ directory with: - quick-start.md: five-minute walkthrough for AI agent developers - comparison.md: factual comparison vs orgparse and organice Timed to support Show HN (Sep 2) and the r/emacs post (Aug 28).
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
docs/quick-start.md— five-minute walkthrough covering workspace loading, task querying, task creation, concurrency, and dependency plansdocs/comparison.md— factual comparison vs orgparse and organice for developers choosing a libraryVerification
All code examples API-audited against v0.5.3 (installed locally). Every method signature, argument name, and return type verified:
OrgWorkspace,Query,Plan,TaskClaim,OptimisticLock,StateConfigws.create_node,ws.transition,ws.saveq.ai_tasks,q.overdue,q.by_property,q.next_actiontc.claim,tc.releaseplan.ready_tasks,plan.blocked_tasksContext
Timed to support Show HN on Sep 2 and r/emacs post today (Aug 28). Part of H001 (org-workspace 100+ downloads/month) distribution wave.
🤖 Generated with Claude Code