Repository navigation
docs: rewrite the README and move customization to its own page - #492
Merged
Merged
Conversation
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configuration
⛔ Files ignored due to path filters (1)
📒 Files selected for processing (3)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Haz3-jolt
force-pushed
the
docs/readme-rewrite
branch
from
October 5, 2026 22:44
14d921e to
879f7eb
Compare
The README now describes the product as it is: what Axl solves, a quick start, how the daemon and clients fit together, the web client, models, sandboxing, and extension points. It adds the project badges and the mascot animation. The instructions, Skills, prompt template, theme, and MCP details move unchanged to docs/customization.md. Signed-off-by: Hari Srinivasan <harisrini21@gmail.com>
Haz3-jolt
force-pushed
the
docs/readme-rewrite
branch
from
October 5, 2026 22:46
879f7eb to
3c9ccba
Compare
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.
Purpose
The README was long, mixed setup detail into the overview, still said the web client did not exist, and referred to roadmap phases. This rewrites it as a README for the product as it is today, with the project badges and the mascot.
Fixes
Fixes #
Approach
docs/customization.md.docs/img/axolotl.gif, built from the existing Pink atlas (idlewaitingloop, 2x, transparent), and covers it in the existing mascot entry inREUSE.toml. No compatibility or security impact.How was this tested?
pnpm format:check: passed.reuse lint(not installed locally), link checking, GitHub rendering of the README.Learning
None.
Checklist
REUSE.toml.Signed-off-bytrailer.AI assistance