Skip to content

Add Reference sidebar landing pages to fix breadcrumb navigation#2003

Merged
cderv merged 3 commits into
mainfrom
add-reference-landings
May 18, 2026
Merged

Add Reference sidebar landing pages to fix breadcrumb navigation#2003
cderv merged 3 commits into
mainfrom
add-reference-landings

Conversation

@cderv
Copy link
Copy Markdown
Member

@cderv cderv commented Apr 29, 2026

When clicking the Formats breadcrumb on /docs/reference/formats/<page>.html, the link led to formats/html.html (the first child) instead of a section landing. The Reference > More section had a similar issue and was not a coherent grouping for its contents.

Adds explicit landing pages for three Reference sidebar sections so the breadcrumb renders as a clickable link to a real page:

  • Formats → new docs/reference/formats/index.qmd
  • Projects → new docs/reference/projects/index.qmd
  • More → renamed to Metadata and pointed at new docs/reference/metadata/index.qmd

The MoreMetadata rename matches the grouping already used in docs/reference/reference.yml (the master listing the website renders) — Dates, Globs, Citations, Cross-References, and Brand are now grouped under Metadata in the sidebar too. The five items themselves are unchanged.

Each landing mirrors the existing docs/reference/cells/ pattern: small index.qmd shell + a per-subdir reference.yml subset rendered by the existing ejs/links.ejs template. No new extension, shortcode, or filter. The master docs/reference/reference.yml is untouched.

Reported in quarto-dev/quarto-cli#14402. The underlying CLI fallback behavior (sidebar sections without href: use contents[0].href) is tracked separately at quarto-dev/quarto-cli#14454 and is not addressed here. Inner Guide sub-sections (HTML/PDF/MS Word/Typst/Markdown under Documents) and Reference > Quarto CLI continue to inherit the same fallback and are deferred.

A follow-up PR will fix the Documents section in the Guide sidebar.

@github-actions github-actions Bot temporarily deployed to pull request April 29, 2026 13:34 Inactive
@github-actions
Copy link
Copy Markdown
Contributor

@cderv cderv requested a review from cwickham April 29, 2026 13:38
Copy link
Copy Markdown
Member

@cwickham cwickham left a comment

Choose a reason for hiding this comment

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

This looks great to me.

@cderv cderv merged commit 32e1c70 into main May 18, 2026
5 checks passed
@cderv cderv deleted the add-reference-landings branch May 18, 2026 18:03
@github-actions
Copy link
Copy Markdown
Contributor

Successfully created backport PR for prerelease:

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