Skip to content

Split reference sections out of the README into docs/ - #76

Merged
patakuti merged 1 commit into
mainfrom
docs/split-readme
Oct 3, 2026
Merged

patakuti merged 1 commit into
mainfrom
docs/split-readme

Conversation

@patakuti

@patakuti patakuti commented Oct 3, 2026

Copy link
Copy Markdown
Owner

Fixes #75

Summary

README: 538 -> 238 lines. It now covers the pitch, comparison, features, quick start, use cases, a Documentation index, security summary, installation, build, known limitations, contributing, project structure and history.

Moved to docs/ (content moved, not rewritten):

File Content
docs/usage.md URL scheme, command line (was "Usage"), configuration file, CSS themes, operation modes, access logging, live reload, math rendering
docs/claude-code-conversation.md Claude Code Stop hook recipe (links to docs/examples/claude-transcript-to-md.sh)
docs/private-repositories.md Private repository access

Checks

  • Total character count is preserved apart from the new index and "Back to README" links.
  • All relative file links resolve; the former in-page anchor links were updated.

🤖 Generated with Claude Code

README keeps the pitch, comparison, security summary, installation and
contributing. Usage reference, the Claude Code conversation recipe and the
private repository guide move to docs/. Content is moved, not rewritten.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@patakuti
patakuti merged commit d375e0f into main Oct 3, 2026
2 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.

Split the README: move reference sections into docs/

1 participant