Refresh docs landing page#10
Conversation
Rework the MkDocs home page so it behaves like a clearer operator-first landing page. Highlights: - rewrite docs/index.md around simpler start actions and grouped sections - add a lightweight homepage stylesheet for restrained card and button structure - keep the existing docs navigation intact while improving hierarchy on the landing page - update mkdocs.yml to load the new stylesheet and point site_url at the published docs host - simplify the homepage wording with a KISS pass to remove documentation-strategy language and keep the copy plain Validation: - ran mkdocs build --strict successfully after the landing-page and copy updates
There was a problem hiding this comment.
Pull request overview
Refreshes the OrbitDeck documentation landing page to be a clearer, operator-first homepage while keeping the existing MkDocs navigation structure intact.
Changes:
- Rewrites
docs/index.mdinto a structured homepage (intro/actions + sectioned link cards). - Adds a lightweight homepage stylesheet and wires it into MkDocs via
extra_css. - Updates
site_urlto the published docs host.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| mkdocs.yml | Updates canonical site_url and includes the new homepage stylesheet via extra_css. |
| docs/index.md | Rebuilds the homepage content into operator-focused sections with card/button layout. |
| docs/stylesheets/docs-home.css | Adds restrained styling for homepage intro, action buttons, and card grids. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <a class="od-home-button od-home-button--primary" href="guide/quickstart/">Get started with Quick Start</a> | ||
| <a class="od-home-button" href="guide/first-hour/">Follow the First Hour walkthrough</a> | ||
| <a class="od-home-button" href="guide/common-tasks/">Jump to Common Tasks</a> |
There was a problem hiding this comment.
This page links to other docs using directory-style URLs (e.g. guide/quickstart/, api/http-api/, INSTALL_AND_RUN/). Elsewhere in the docs and in mkdocs.yml nav, links point to the source .md files. Using the trailing-slash form can break when viewing docs on GitHub or if use_directory_urls is ever changed; consider switching these href values to the corresponding .md paths for consistency and portability (MkDocs will still rewrite them to pretty URLs in the built site).
| border: 1px solid color-mix(in srgb, var(--md-default-fg-color) 12%, transparent); | ||
| border-radius: 0.9rem; | ||
| background: color-mix(in srgb, var(--md-code-bg-color) 60%, transparent); | ||
| color: var(--md-default-fg-color); |
There was a problem hiding this comment.
color-mix() is used for several border/background colors here. On browsers that don’t support color-mix (not uncommon on older Chromium builds), those declarations are dropped entirely, which can leave the cards/buttons without visible borders/backgrounds. Consider adding a plain-color fallback first (or wrapping the color-mix rules in @supports) so the homepage styling degrades gracefully.
What changed
This refresh rebuilds the docs landing page so it works as a simpler operator-first homepage.
It now:
site_urlto the published docs host athttps://chipsncode.com/OrbitDeck/Why
The old docs homepage was accurate, but it felt like a short index page and used too much meta language. This pass makes the landing page easier to scan, easier to trust, and easier to use without turning it into a flashy marketing page.
Scope
Included:
docs/index.mddocs/stylesheets/docs-home.cssmkdocs.ymlNot included:
Validation
mkdocs build --strictsuccessfully after the landing-page updates