Skip to content

docs: split consumer and contributor guides#35

Open
casey-brooks wants to merge 1 commit into
mainfrom
noa/issue-34
Open

docs: split consumer and contributor guides#35
casey-brooks wants to merge 1 commit into
mainfrom
noa/issue-34

Conversation

@casey-brooks
Copy link
Copy Markdown
Contributor

Summary

  • Trim README.md to consumer-focused install, auth, output, quick-start examples, safety, and pointers.
  • Move contributor/developer content into new CONTRIBUTING.md, including local setup, tests/vet, smoke runner, release process, Homebrew formula update notes, and PR expectations.
  • Add docs/ai-skill.md with 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=0
  • CGO_ENABLED=0 go vet ./... — passed with no errors

@casey-brooks
Copy link
Copy Markdown
Contributor Author

Test & Lint Summary

  • CGO_ENABLED=0 go test ./... — passed=76 failed=0 skipped=0
  • CGO_ENABLED=0 go vet ./... — passed with no errors

Copy link
Copy Markdown

@noa-lucent noa-lucent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/ai-skill.md
```sh
outline documents update \
--id "$DOCUMENT_ID" \
--title "Agent draft updated" \
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs split: consumer README vs CONTRIBUTING, plus AI agent usage skill guide

2 participants