docs: redesign the docs UI — dark-first, instrument-panel identity (#239)#242
Merged
Merged
Conversation
…OpenAgentHQ#239) Co-Authored-By: Kimi K3 <noreply@kimi.com>
|
🎉 Congratulations @Nitjsefnie! Your pull request has been successfully merged into main. 🚀 Thank you for contributing to OpenAgentHQ and helping improve the project. We truly appreciate your contribution and hope to see you back with more amazing PRs! Happy Open Sourcing! ❤️ |
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.
Closes #239
Overhauls the docs theme layer to the plan you approved in the issue thread — MkDocs Material kept as the base, dark-mode-first, anchored to the org mark, with a proper landing page, cleaner scannability, and consistent code styling.
mkdocs build --strictpasses clean (zero warnings).After (dark — the flagship)
Before → After (dark) · click to expand the before
Before:
Light scheme (before → after)
After (light):
Before (light):
Mobile (after, 390px)
What changed
#0b0c0e/ off-white#fcfcfasystem with a single accent. The accent is a signal vermilion (#ff5d3bon dark ≈6.4:1,#c4370fon light ≈5.2:1, both AA). It's chosen to read as instrumentation — probes, calibration, pass/fail registers — rather than the generic dev-tool blue or the acid-green everyone reaches for; measurement is what an eval framework is about.pip install→oaeval init→oaeval run→ report with scores). The word evaluation in the headline carries the accent.prefers-reduced-motion.Files:
docs/stylesheets/extra.css(the bulk),mkdocs.yml(palette),docs/index.md(hero + card grids),docs/overrides/main.html(font link), and the two brand SVGs (see below).Two things for your call
logo.svg/favicon.svgwere actually indigo — leaving them would drop a spot of the old color into the new palette. I recolored them to the near-black mark with a single vermilion signal dot so the identity is cohesive. This is the one place the PR touches brand assets rather than the theme layer — if you'd rather keep the current mark untouched, it's a two-file revert and the theme works either way. Your call.docs/assets/hero.svgis now unreferenced (the terminal replaced it) but left in place — it's still indigo if you ever reuse it. Happy to delete it if you'd prefer no orphan.Not touched (flagging, out of scope)
docs/index.md's "Stay connected" links X asx.com/openagentdevwhilemkdocs.yml's social config usesx.com/openagenthq— a pre-existing content inconsistency, not a theme issue. Left alone; easy follow-up if you want it fixed.Verification
pip install mkdocs-material && mkdocs build --strict→ built clean, zero warnings (strict turns any broken link/nav/ref into an error).:material-*:icons resolve, fonts wired, hero terminal renders.Generated by Claude Opus 4.8 (brief, review), Kimi K3 (implementation).