Repository navigation
Rewrite the README as a short project front page and move detail into docs - #211
Open
titanwings wants to merge 1 commit into
Open
titanwings wants to merge 1 commit into
titanwings wants to merge 1 commit into
Conversation
… docs The README now answers what Distilly is, why personal agents need it, how to install and use it, how it works (with a Mermaid diagram), which agents it supports, and where the docs are. Everything it no longer shows moved into docs/how-it-works.md, docs/data-sources.md, docs/hosts.md, docs/examples.md and docs/news.md. README_ZH.md is retranslated to match. The README tests now find sections by heading name instead of emoji, and the translation sync test compares section counts because headings are translated. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BCNTLRpPjuxPaVo3prVatk
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.
Requested by Tianyi · project thread
Summary
The README now reads like a mature project's front page: what Distilly is, why personal agents need it, quick start, how it works (with a diagram), supported agents, docs links and citation. It goes from 359 lines to 136. Nothing was deleted: every section it no longer shows moved into
docs/.Changes
README.md: new structure, with a Mermaid architecture diagram drawn at the level users see (material, Distilly inside your agent, Person Profiles, owner profile, host). It does not name internal modules, since those will move in the planned refactor.docs/how-it-works.md(person families, profile structure, evolution, source-material priorities, technical report, the step-by-step create flow),docs/data-sources.md,docs/hosts.md(native hosts and personal-agent status),docs/examples.md(the three demos) anddocs/news.md(announcements, milestone, star history).docs/lang/README_ZH.md: retranslated in full to match the new README, as Slim translated docs to English source plus full Chinese translation #207 requires.tests/test_skill_entrypoint_docs.py: README checks now find the hosts and quick-start sections by heading name (one entry each for README.md and README_ZH.md) instead of### 3️⃣/## ⚡/## ✨. What gets checked is unchanged: the 8 hosts in order, every logo, Grok Bot, the clone command,{character}-{slug}, the install guide link, and no installer or research commands in the quick start.tests/test_translation_sync.py: compares the number of##sections instead of their first word, because headings are now translated words rather than shared emoji. The checks on images and external links are unchanged.Motivation
The old front page mixed install details, data sources, host matrices, news and citations, which made it hard to scan.
Testing
python -m unittest discover -s tests -p 'test_*.py'passed (123 tests)python -m compileall tools/passedChecklist
🤖 Generated with Claude Code
https://claude.ai/code/session_01BCNTLRpPjuxPaVo3prVatk
Generated by Claude Code