fix(docs): owl intro, feature tables, MCP page; drop stale-branded images - #100
Merged
Conversation
…ages Lead the README + docs overview with a short owl intro (Bubo = the eagle-owl genus, Wikipedia-linked) drawing the owl <-> code-review parallel. Replace the dense feature bullet list with a scannable at-a-glance table, and restyle the overview's hero links as Material grid cards. Add a dedicated docs/mcp.md (moved out of run.md, which now points to it) and surface metrics by renaming the nav entry to "Metrics & telemetry". Drop the stale-branded images that can't be pixel-edited: the hero banner had the old github.com/mountainowl/ai-code-review URL baked in, and the two GitLab MR screenshots show the old "LLM Reviewer" bot. Removing them from the README also clears the wrong-URL hero from the PyPI project page (this fix: cuts a release that republishes the cleaned README). Fresh Bubo-branded visuals can follow. mkdocs --strict clean.
This was referenced Jun 16, 2026
mountainowl
added a commit
that referenced
this pull request
Jun 16, 2026
The docs overhaul in #100 dropped the hero render and the stale-branded GitLab MR screenshots from the README, but the layout guard still required those exact image references — so main CI has been red since #100 (the only failing assertion was the README hero reference; several more in the same block were latently false). Rewrite the asset block to assert only the assets the README currently links to (avatar preview, examples doc, bot avatar), each checked both for on-disk presence and for an actual README reference. This keeps the broken-link guard meaningful without pinning files the docs no longer use. Co-authored-by: mountainowl <mountainowl@users.noreply.github.com>
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
1 participant
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.
A documentation polish pass addressing the readability + branding gaps.
What changed
docs/mcp.md— a dedicated MCP-server setup page (two interfaces + the three deployment patterns), moved out ofrun.md(which now points to it).The "/ai-code-review on images" bug — root cause + fix
It wasn't in any markdown (only the historical CHANGELOG rename entries, which are correct). It was baked into image pixels: the hero banner literally shows
github.com/mountainowl/ai-code-review, and the two GitLab MR screenshots show the old "LLM Reviewer" bot. I can't edit pixels, so I removed those stale images from the README/docs — which also clears the wrong-URL hero from the PyPI page (thisfix:cuts a release that republishes the cleaned README). The image files remain indocs/images/for regeneration. Fresh Bubo-branded visuals (hero with the right URL; screenshots with the Bubo bot) need to be regenerated — I can build an SVG hero for the docs site if you want one.Not in this PR (already written elsewhere)
GitHub Marketplace + self-hosted-runner guidance live in #99 (
docs/github-action.md) — merge #99 to make them live; I kept them with the action to avoid duplication.Verify
mkdocs build --strictclean (grid cards, new MCP page, tables, nav all build); no stale image refs remain in rendered docs;czvalid; no footer. README links stay absolute (PyPI-safe).