Refactor templates by osfameron · Pull Request #199 · couchbase/docs-ui

osfameron · 2026-04-20T12:29:59Z

No description provided.

With Claude

Copilot

Pull request overview

Refactors the Handlebars templates by centralizing the HTML shell into a shared partial, simplifying specialized layouts, and removing the contributor-bot feature/assets.

Changes:

Added a reusable layout-shell partial and updated multiple layouts to delegate to it.
Consolidated landing-page variants into a single body-landing partial with conditional navigation behavior.
Removed contributor-bot markup, JS, and CSS.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/partials/main.hbs	Removed legacy `main` partial content (moved into `body.hbs`).
src/partials/layout-shell.hbs	New shared HTML document shell used by multiple layouts.
src/partials/head-rest-api.hbs	New REST API head additions (Redoc styling/metadata).
src/partials/contributor-bot.hbs	Removed contributor-bot partial.
src/partials/body.hbs	Inlined former `main` partial content into `body`.
src/partials/body-rest-api.hbs	New REST API body partial rendering `page.contents`.
src/partials/body-landing.hbs	Reworked landing body to be content-driven with conditional nav variants.
src/partials/body-landing-tutorials.hbs	Removed in favor of `body-landing` + `nav` option.
src/partials/body-landing-top-level-sdk.hbs	Removed in favor of `body-landing` + `nav` option.
src/partials/body-landing-sdk.hbs	Removed in favor of `body-landing` + `nav` option.
src/partials/body-landing-page-capella.hbs	Removed in favor of `body-landing` + capella options.
src/partials/body-landing-core-concept.hbs	Removed in favor of `body-landing` + `nav` option.
src/partials/article.hbs	Removed contributor-bot include from articles.
src/layouts/tutorials.hbs	Switched to `layout-shell` with `body-tutorials`.
src/layouts/rest-api.hbs	Switched to `layout-shell` with REST API head/body partials.
src/layouts/landing-page.hbs	Switched to `layout-shell` + `body-landing`.
src/layouts/landing-page-tutorials.hbs	Switched to `layout-shell` + `body-landing` with tutorials nav variant.
src/layouts/landing-page-top-level-sdk.hbs	Switched to `layout-shell` + `body-landing` with sidebar variant.
src/layouts/landing-page-sdk.hbs	Switched to `layout-shell` + `body-landing` with full nav.
src/layouts/landing-page-core-concept.hbs	Switched to `layout-shell` + `body-landing` with full nav.
src/layouts/landing-page-capella.hbs	Switched to `layout-shell` + `body-landing` with capella styling options.
src/layouts/home.hbs	Switched to `layout-shell` and `siteTitleOnly` title behavior.
src/layouts/default.hbs	Switched to `layout-shell` with default title.
src/layouts/404.hbs	Switched to `layout-shell` with 404 body/template settings.
src/js/08-contributor-bot.js	Removed contributor-bot JS.
src/css/site.css	Dropped import of `contributor.css`.
src/css/contributor.css	Removed contributor-bot styling.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T12:35:04Z

+<style>
+#redoc { width: 100%}
+</style>
+<meta name='viewport' content='width=device-width, initial-scale=1' />


head-first already includes a viewport meta tag (see src/partials/head-first.hbs:3), so adding another viewport meta here will result in duplicate viewport declarations on REST API pages. Remove the viewport meta from this partial and keep it centralized in head-first (or make head-first conditional).

Suggested change

<meta name='viewport' content='width=device-width, initial-scale=1' />

Copilot · 2026-04-20T12:35:05Z

@@ -0,0 +1,4 @@
+<style>
+#redoc { width: 100%}


The #redoc inline CSS rule is missing a trailing semicolon (width: 100%). Please add the semicolon to avoid issues when additional declarations are appended/minified.

Suggested change

#redoc { width: 100%}

#redoc { width: 100%; }

Copilot · 2026-04-20T12:35:05Z

+{{> layout-shell
+    siteTitleOnly=true
+    bodyClass="home"
+    bodyTemplate="body-home"}}


This changes the home page <title> from a fixed "Couchbase Documentation" string to site.title via siteTitleOnly=true. If this PR is intended to be a refactor-only change, consider preserving the previous title text (or explicitly documenting this behavior change).

Copilot · 2026-04-20T12:35:06Z

+<img class="opening-image" src="{{{uiRootPath}}}/img/stars.svg" />
+{{/if}}
+{{{page.contents}}}
+{{#if capellaImages}}
+<img class="ending-image" src="{{{uiRootPath}}}/img/lineplus.svg" />


The decorative Capella images are missing alt text. Please add alt="" (and optionally aria-hidden="true" / role="presentation") so screen readers don’t announce the filenames/URLs.

Suggested change

<img class="opening-image" src="{{{uiRootPath}}}/img/stars.svg" />

{{/if}}

{{{page.contents}}}

{{#if capellaImages}}

<img class="ending-image" src="{{{uiRootPath}}}/img/lineplus.svg" />

<img class="opening-image" src="{{{uiRootPath}}}/img/stars.svg" alt="" aria-hidden="true" />

{{/if}}

{{{page.contents}}}

{{#if capellaImages}}

<img class="ending-image" src="{{{uiRootPath}}}/img/lineplus.svg" alt="" aria-hidden="true" />

simplify by removing additionalHeadTemplate

Copilot

Pull request overview

Copilot reviewed 27 out of 27 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T12:51:50Z

-</html>
+{{> layout-shell
+    bodyClass="landing-page"
+    defaultTitle="Landing Page"


defaultTitle is capitalized as "Landing Page" here, but other landing-page layouts in this PR use "landing page" (and the previous template used "landing page"). This will change the browser title casing only for some landing pages; consider standardizing the default title across all landing-page layouts.

Suggested change

defaultTitle="Landing Page"

defaultTitle="landing page"

Copilot · 2026-04-20T12:51:51Z

  color: inherit;
 }

+#redoc { width: 100%; }


This new rule is formatted as a single-line block, but the surrounding rules in this file use multi-line blocks (e.g., code { ... } at src/css/base.css:69-73 and #redoc code { ... } at :76-79). Consider formatting #redoc consistently to match the established style.

Suggested change

#redoc { width: 100%; }

#redoc {

width: 100%;

}

Copilot · 2026-04-20T12:51:52Z

-</html>
+{{> layout-shell
+    bodyClass="landing-page"
+    defaultTitle="Landing Page"


defaultTitle is capitalized as "Landing Page" here, but other landing-page layouts in this PR use "landing page" (and the previous template used "landing page"). This will change the browser title casing only for some landing pages; consider standardizing the default title across all landing-page layouts.

Suggested change

defaultTitle="Landing Page"

defaultTitle="landing page"

Copilot

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-21T14:16:35Z

+<html lang="en">
+<head>
+{{> head-first}}
+<title>{{#if siteTitleOnly}}{{{site.title}}}{{else}}{{{detag (or page.title defaultTitle)}}}{{#with site.title}} | {{{.}}}{{/with}}{{/if}}</title>


In the <title> tag, site.title is rendered with triple-stash ({{{site.title}}} / {{{.}}}), which disables HTML escaping. If site.title contains &, <, or other special characters, this can produce invalid markup and potentially allow HTML injection into the document title. Prefer the escaped form ({{site.title}} / {{.}}) and let Handlebars handle entity escaping (keep detag(...) for page.title if needed).

Suggested change

<title>{{#if siteTitleOnly}}{{{site.title}}}{{else}}{{{detag (or page.title defaultTitle)}}}{{#with site.title}} | {{{.}}}{{/with}}{{/if}}</title>

<title>{{#if siteTitleOnly}}{{site.title}}{{else}}{{{detag (or page.title defaultTitle)}}}{{#with site.title}} | {{.}}{{/with}}{{/if}}</title>

Copilot · 2026-04-21T14:16:36Z

+<article class="doc">
+{{#if page.title}}
+<div class="page-heading-title">
+<h1 class="page">{{{page.title}}}</h1>
+{{> labels}}
+</div>
+{{/if}}
+{{{page.contents}}}
+{{> pagination}}
+</article>


article.hbs previously included {{> contributor-bot}} (plus related CSS/JS). With the article markup now inlined here and the partial deleted, the contributor/last-commit UI has been removed entirely. If that feature is still expected on article pages, re-add it (either by restoring the partial or embedding it here) and ensure the supporting assets are still included; otherwise, consider updating the PR title/description to reflect this intentional functional removal (not just a refactor).

osfameron added 3 commits April 17, 2026 16:27

remove contributor-bot

af11068

Refactor of landing page templates

7f9ddea

With Claude

Refactor templates to layout-shell

8528bfc

osfameron requested a review from Copilot April 20, 2026 12:29

Copilot started reviewing on behalf of osfameron April 20, 2026 12:30 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

tweaks

63410e9

simplify by removing additionalHeadTemplate

osfameron requested a review from Copilot April 20, 2026 12:46

Copilot started reviewing on behalf of osfameron April 20, 2026 12:47 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

osfameron added 3 commits April 20, 2026 13:53

capitalisation

1e26af0

refactor article back into body

89e1327

move llms/watermark to standard location

9ab3387

osfameron requested a review from Copilot April 21, 2026 14:11

Copilot started reviewing on behalf of osfameron April 21, 2026 14:12 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

osfameron merged commit c24ab98 into master Apr 24, 2026
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor templates#199

Refactor templates#199
osfameron merged 7 commits into
masterfrom
refactor-templates

osfameron commented Apr 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	<title>{{#if siteTitleOnly}}{{{site.title}}}{{else}}{{{detag (or page.title defaultTitle)}}}{{#with site.title}} \| {{{.}}}{{/with}}{{/if}}</title>
	<title>{{#if siteTitleOnly}}{{site.title}}{{else}}{{{detag (or page.title defaultTitle)}}}{{#with site.title}} \| {{.}}{{/with}}{{/if}}</title>

Conversation

osfameron commented Apr 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants