Skip to content

Use h2 for default section headings in Aliki - #1842

Open
st0012 wants to merge 1 commit into
masterfrom
codex/aliki-default-h2
Open

st0012 wants to merge 1 commit into
masterfrom
codex/aliki-default-h2

Conversation

@st0012

@st0012 st0012 commented Oct 3, 2026

Copy link
Copy Markdown
Member

Use h2 for the default Constants, Attributes, and method group headings in Aliki. This better follows W3C guidance on heading hierarchy and fixes their misleading nesting in “On This Page.”

Keep h3 for headings inside named sections, where they sit below the section’s h2 heading.

Fixes #1822.

Copilot AI balanced review requested due to automatic review settings October 3, 2026 23:17
@github-actions

github-actions Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Documentation preview

View the preview

Commit: dc2301b

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 review overview

🟡 Changes recommended

Regression tests are needed for both default and named section heading levels.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
What changed in this PR

Updates Aliki’s heading hierarchy to correctly represent default and named sections.

Changes:

  • Uses h2 for default Constants, Attributes, and method headings.
  • Retains h3 beneath named section headings.
File Description
lib/​rdoc/​generator/​template/​aliki/​class.rhtml Selects heading levels based on whether the section is named.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread lib/rdoc/generator/template/aliki/class.rhtml
@st0012 st0012 added the bug label Oct 4, 2026
Copilot AI balanced review requested due to automatic review settings October 5, 2026 00:25
@st0012
st0012 force-pushed the codex/aliki-default-h2 branch from 8f81d82 to dc2301b Compare October 5, 2026 00:25

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 review overview

🟢 Approval recommended

The focused template changes match the requested hierarchy and are covered by representative regression assertions.

Review effort: Balanced
Findings: None

Resolved since last review (1)

This branch has not been deployed

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Wrong heading levels in generated HTML?

2 participants