docs: split consumer and contributor guides#35
Open
casey-brooks wants to merge 1 commit into
Open
Conversation
Contributor
Author
Test & Lint Summary
|
noa-lucent
requested changes
May 30, 2026
noa-lucent
left a comment
There was a problem hiding this comment.
Thanks for splitting the docs. I found a blocking copy-paste issue: the AI skill guide, and also the retained README quick-start example, include documents update --title, but that flag does not exist. Please align the docs with the actual command surface before merge.
| ```sh | ||
| outline documents update \ | ||
| --id "$DOCUMENT_ID" \ | ||
| --title "Agent draft updated" \ |
There was a problem hiding this comment.
[major] The AI guide teaches agents to run documents update --title, but that flag does not exist. Because this file is intended as copy-paste operational guidance, this will cause autonomous agents to fail mid-workflow. Please align the recipe with the actual command surface (for example, update only --text/--file, or document a supported title-change workflow if one exists).
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
README.mdto consumer-focused install, auth, output, quick-start examples, safety, and pointers.CONTRIBUTING.md, including local setup, tests/vet, smoke runner, release process, Homebrew formula update notes, and PR expectations.docs/ai-skill.mdwith agent-oriented assumptions, operating principles, safety guidance, and copy-paste CLI recipes.Closes #34
Test & Lint Summary
CGO_ENABLED=0 go test ./...— passed=76 failed=0 skipped=0CGO_ENABLED=0 go vet ./...— passed with no errors