Skip to content

docs: glitches spotted while reviewing #1304 - #1315

Merged
alandefreitas merged 4 commits into
cppalliance:developfrom
alandefreitas:docs/glitches
Sep 22, 2026
Merged

alandefreitas merged 4 commits into
cppalliance:developfrom
alandefreitas:docs/glitches

Conversation

@alandefreitas

Copy link
Copy Markdown
Collaborator

A few documentation fixes I noticed in passing while reviewing #1304. None of them depend on that PR. They were things that looked off while I read the docs alongside it.

Changes

The old design notes page is gone, and its content now lives in its corresponding pages when each topic is introduced. The home page now explains the case for generating docs from source. The extraction page now covers overload sets, SFINAE, and function objects. The customization ladder is on the generators overview, and the extensions section gained an overview page, since it had none. The license page was dropped from the site. The code-block override example gained an HTML tab, and the AsciiDoc syntax highlighter now understands inline macros, so an underscore inside a link target no longer opens a false emphasis span. The library examples include their CMake code with the indentation stripped and a sentence between the two blocks.

Testing

The docs site builds locally in author mode with no new warnings. CI tests the workflow. No code paths are affected.

Documentation

This PR is documentation.

@github-actions

Copy link
Copy Markdown
Contributor

✨ Highlights

  • 🧪 Existing golden tests changed (behavior likely shifted)

🧾 Changes by Scope

Scope Lines Δ% Lines Δ Lines + Lines - Files Δ Files + Files ~ Files ↔ Files -
📄 Docs 94% 506 113 393 14 1 10 - 3
🥇 Golden Tests 6% 32 32 - 2 1 1 - -
Total 100% 538 145 393 16 2 11 - 3

Legend: Files + (added), Files ~ (modified), Files ↔ (renamed), Files - (removed)

🔝 Top Files

  • docs/modules/ROOT/partials/LICENSE.txt (Docs): 279 lines Δ (+0 / -279)
  • docs/modules/ROOT/pages/design-notes.adoc (Docs): 80 lines Δ (+0 / -80)
  • docs/modules/ROOT/pages/index.adoc (Docs): 31 lines Δ (+31 / -0)

Generated by 🚫 dangerJS against 5f2de3a

@codecov

codecov Bot commented Sep 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.12%. Comparing base (b45d019) to head (5f2de3a).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1315   +/-   ##
========================================
  Coverage    83.12%   83.12%           
========================================
  Files           35       35           
  Lines         3662     3662           
  Branches       844      844           
========================================
  Hits          3044     3044           
  Misses         410      410           
  Partials       208      208           
Flag Coverage Δ
bootstrap 83.12% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@cppalliance-bot

Copy link
Copy Markdown

An automated preview of the documentation is available at https://1315.mrdocs.prtest2.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-09-22 05:29:24 UTC

@alandefreitas
alandefreitas added this pull request to the merge queue Sep 22, 2026
Merged via the queue into cppalliance:develop with commit af4269b Sep 22, 2026
32 checks passed
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