Skip to content

Polish Aliki documentation theme#1742

Open
st0012 wants to merge 11 commits into
ruby:masterfrom
st0012:claude/unruffled-yalow-3fad0c
Open

Polish Aliki documentation theme#1742
st0012 wants to merge 11 commits into
ruby:masterfrom
st0012:claude/unruffled-yalow-3fad0c

Conversation

@st0012

@st0012 st0012 commented Jun 24, 2026

Copy link
Copy Markdown
Member

Problem

The Aliki HTML theme has several small visual inconsistencies that add up when browsing generated documentation: method cards and source toggles compete for attention, selected and nested navigation states create uneven spacing, page titles do not clearly distinguish object kind from object name, section dividers are visually heavy, the footer can sit awkwardly against the sidebar at narrower desktop widths, and the desktop search field is not aligned with the main reading column.

These issues make the default generated docs feel less polished than the underlying content warrants, especially on method-heavy pages and wide layouts with both side navigation and the table of contents visible.

Solution

  • Add a DESIGN.md contract for the Aliki theme so spacing, color, navigation, method-card, search, title, and footer decisions are documented in one place.
  • Refine method cards, source controls, borders, and section dividers so code-object pages read with clearer hierarchy and less visual noise.
  • Clarify generated navigation structure by giving the left sidebar and right table of contents distinct IDs and matching selector names.
  • Improve page-title kind labeling, nested sidebar spacing, and footer behavior across desktop breakpoints.
  • Align the desktop search field and dropdown to the main content rail while preserving the existing mobile search modal behavior.

Screenshots

Before

Screenshot 2026-06-24 at 15 55 34
Screenshot 2026-06-24 at 15 56 45

After

Screenshot 2026-06-24 at 15 56 06
Screenshot 2026-06-24 at 15 56 37

st0012 added 10 commits June 13, 2026 18:40
Document Aliki's visual design language as a single source of truth for
the css/rdoc.css stylesheet, in the Stitch DESIGN.md nine-section format:
theme/atmosphere, color palette and roles (light + dark), typography,
component stylings, layout, depth/elevation, do's and don'ts, responsive
behavior, and an agent quick reference.

Visual scope only; all token and component values are transcribed from
css/rdoc.css.
Copilot AI review requested due to automatic review settings June 24, 2026 14:47
@st0012 st0012 requested a deployment to fork-preview-protection June 24, 2026 14:47 — with GitHub Actions Waiting

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@st0012 st0012 deployed to fork-preview-protection June 24, 2026 15:04 — with GitHub Actions Active
@matzbot

matzbot commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

🚀 Preview deployment available at: https://f2e71367.rdoc-6cd.pages.dev (commit: cd2b3a1)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants