Skip to content

docs: restructure READMEs into per-package entrypoints - #49

Merged
urmzd merged 1 commit into
mainfrom
docs/readme-restructure
Jul 12, 2026
Merged

docs: restructure READMEs into per-package entrypoints#49
urmzd merged 1 commit into
mainfrom
docs/readme-restructure

Conversation

@urmzd

@urmzd urmzd commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Summary

docs

  • Slim the root README (891 to ~140 lines) to marketing and quick start, with a documentation table routing to per-package READMEs
  • Add package READMEs as deeper entrypoints: agent, knowledge, rag, eval, cmd/saige, cmd/saige-mcp (with Claude Code / Codex / Gemini CLI setup), tools/research, examples
  • Add missing Go package doc comments (agent, all six providers, agent/tree, agent/types, knowledge, knowledge/internal/extraction); every non-example package now has a pkg.go.dev synopsis
  • Remove all em dashes across markdown, llms.txt, skills, Go comments, and user-facing strings (CLI help, tool descriptions); fix two SKILL.md frontmatter descriptions where the sweep would have introduced an unquoted colon into YAML
  • Index the new per-package READMEs in llms.txt

Verification

  • go build ./..., go vet ./..., go test ./... all pass
  • Link checker over all new/changed docs: 0 broken relative links
  • Zero em dashes remain in *.md, *.go, llms.txt

- slim root README to marketing and quick start with a documentation table
- add package READMEs: agent, knowledge, rag, eval, cmd/saige, cmd/saige-mcp,
  tools/research, examples
- add missing package doc comments (agent, providers, tree, types, knowledge)
- remove em dashes across markdown, llms.txt, Go comments, and CLI/tool strings
- index per-package READMEs in llms.txt
@urmzd
urmzd merged commit 125f4c9 into main Jul 12, 2026
6 checks passed
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.

1 participant