Skip to content

Style the documentation in #main, and the knowledge base pages - #41

Open
paul999 wants to merge 3 commits into
masterfrom
issue-20/docs-in-main
Open

paul999 wants to merge 3 commits into
masterfrom
issue-20/docs-in-main

Conversation

@paul999

@paul999 paul999 commented Sep 19, 2026 •

Copy link
Copy Markdown
Member

Styles for the website's documentation pages, now that they sit in #main like the rest of the site. The User Guide and the Knowledge Base used to render in the old pjax #ajax block.

Belongs to the knowledge base migration in phpbb/phpbb-website-private: #228 (paul999/phpbb-website-private#20) moves the documentation layout into #main, and #229–#232 add the knowledge base pages.

All changes are in css/support_docs.css, which is the stylesheet the docs pages load.

The documentation in #main (ac72ebc)

  • #main gives running text bigger lists, underlined links and red h3 headings. The docs sidebar (#extras), the User Guide menu, the knowledge base category chips and the article list are navigation, so they keep their own size, indent and plain links.
  • A paragraph inside a list item in an article no longer gets a paragraph's margin.
  • The heading above the article list gets its own style (.kb-listing-heading).

Knowledge base pages (2d91d34)

  • .kb-toolbar: the "Submit an article" / "Your articles" buttons at the right of the listing.
  • .kb-back: the link from an article or the submit form back to the knowledge base index. It replaces the category chips there.
  • .kb-article-panel: one panel above an article for its status, a pending revision and the Edit / Review buttons. This replaces three separate notices.
  • The article's tags are plain, not underlined.

Buttons use the shared buttons.css (.submit-buttons .button1/.button2), so nothing here styles a button.

After merge: composer update phpbb/website-assets on the phpbb-website-private branches.

Checked on the local Docker site: the User Guide, the knowledge base index and an article page, measured against the old layout. The rest of the knowledge base pages are part of the Docker test of the phpbb-website-private branches.

🤖 Generated with Claude Code

paul999 and others added 2 commits September 19, 2026 15:15
The website's documentation layout (docs_base.html.twig) puts the User
Guide and the Knowledge Base in #main, as the rest of the site, instead
of the old pjax #ajax block, so the site's text styles and buttons apply
to them. Their sidebar, the User Guide menu, the knowledge base chips and
article list are navigation rather than running text: they keep their
own size, indent and plain links, and a paragraph inside a list item no
longer gets a paragraph's margin.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 19, 2026 14:50

Copilot AI left a comment

Copy link
Copy Markdown

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

There are CSS specificity issues that (1) prevent the KB listing heading divider from appearing under #main and (2) break tag-link hover/focus underline behavior inside #main.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Medium severity · 1 Low severity

Open (2)
What changed in this PR

Updates css/support_docs.css to preserve documentation/knowledge-base navigation styling now that docs render inside #main, and adds/adjusts knowledge-base UI styles (listing heading/toolbar/back link/article panel) to avoid inheriting #main’s running-text presentation.

Changes:

  • Adds #main-scoped overrides for docs sidebar/menu and knowledge base listing elements to avoid inheriting #main link/list/heading styles.
  • Introduces new knowledge-base layout components (.kb-toolbar, .kb-back, .kb-article-panel) and related styling.
  • Tweaks list-item paragraph spacing in documentation content.
File Description
css/​support_docs.css Adds #main-aware documentation/KB styling and new KB UI component styles to match the migrated layout.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread css/support_docs.css
Comment on lines +1238 to +1247
#main .kb-categories a,
#main .kb-articles .kb-title,
#main .kb-article-tags a {
text-decoration: none;
}

#main .kb-articles .kb-title:hover,
#main .kb-articles .kb-title:focus {
text-decoration: underline;
}
Comment thread css/support_docs.css
Comment on lines +1253 to +1257
.support_docs #main .kb-listing-heading {
font-family: inherit;
font-size: 1.3em;
color: #505C65;
}
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.

2 participants