Repository navigation
Modernize docs landing page and apply conventions pass - #37
Merged
Merged
Conversation
1 task done
Aligns existing pages with the CONTRIBUTING.md doc rules:
- Drop chatty "This page covers…" / "本页覆盖…" openers from
quickstart.{en,zh}.md so each page opens directly on its first
numbered section.
- Remove two inline mid-paragraph cross-page links from
examples/overview.{en,zh}.md (Inverted Pendulum + Quickstart §5);
the sibling pages are already in the left-hand nav.
- Rewrite contributing.zh.md to mirror the English doc structure:
drop the blockquote chatty opener, add the missing 文档约定 section,
and update the branch flow from the legacy single-branch model
to the current feat/* → dev → main two-layer flow.
Replaces the bullet-list index with a designed landing page; the underlying doc conventions still apply to every other page. - New hero: monospace eyebrow tag, display-size Fraunces H1 (loaded from Google Fonts), shortened lead, two action buttons. - macOS-style terminal preview under the hero showing actual `genelab list tasks` output for the four registered tasks. - Quick start cards keep the four destinations but gain monospace 01–04 badges, dashed separators, and a lift-on-hover. - Modules section converted from prose bullets to a two-column technical grid (module name + one-line purpose). - TOC hidden on the index only via front-matter (no in-page nav needed when sections double as the nav targets). Accompanying CSS fixes that surfaced during the redesign: - Search input/icons in the header now use dark text in light mode; the previous Material defaults assumed a primary-coloured header and rendered white-on-white once the header background was flipped. - Code-block clipboard button reshaped (8 px rounded, 1.65 rem, inset 0.45 rem) so it no longer crashes into the 12 px corner; fades in on `.highlight:hover` instead of competing with code. All `.gl-*` rules are scoped — other pages are unaffected.
KraHsu
force-pushed
the
docs/landing-page-and-conventions-pass
branch
from
May 15, 2026 14:43
b2b814c to
67661a0
Compare
KraHsu
added a commit
that referenced
this pull request
Jun 5, 2026
…pass Modernize docs landing page and apply conventions pass
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.
Summary
Two commits, both docs-only, no Python touched.
1. Apply documentation conventions pass — bring existing pages back into compliance with
CONTRIBUTING.md(Documentation conventions, lines 26–38):"This page covers…"/"本页覆盖…"openers inquickstart.{en,zh}.md.examples/overview.{en,zh}.md— the sibling pages already live in the left-hand nav.contributing.zh.mdfor parity with the English include: drop the blockquote opener, add the missing文档约定section, and refresh the branch flow from the legacy single-branch model to the currentfeat/* → dev → maintwo-layer flow.2. Modernize docs landing page —
index.{en,zh}.mdandextra.cssonly; index is explicitly exempt from the doc rules and now uses a refined technical/editorial treatment:genelab list tasksoutput for the four registered tasks.01–04badges, dashed separators, lift-on-hover..highlight:hover..gl-*— other pages are not affected.The 7 pyright errors and the pytest torch-import failures observed locally already exist on
origin/devbaseline and are out of scope for this PR.Test plan
uv run ruff check— passesuv run ruff format --check— 160 files already formatteduv run mkdocs build --strict— passesuv run mkdocs serve→/and/zh/render the new hero / terminal / cardsgetting-started/installation/show the rounded clipboard button only on hover