Skip to content

docs: canonical URL, product link and 404 page in the Doxygen theme - #390

Merged
luisleo526 merged 1 commit into
mainfrom
sm/en94-cdocs-seo-a-rc1
Oct 14, 2026
Merged

luisleo526 merged 1 commit into
mainfrom
sm/en94-cdocs-seo-a-rc1

Conversation

@luisleo526

@luisleo526 luisleo526 commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Part A of #380, rebased onto main 04607c1 (v1.6.0-rc.1) as a new branch. This PR carries only the documentation files: docs/Doxyfile and the Doxygen theme (docs/_theme/404.html, footer.html, header.html). Part B (the docs build script, the SEO post-processing, the docs-only CI check with its test, and the CMake registration) follows as its own PR once this one lands. The description below covers the whole of #380.

cdocs.pineforge.dev is indexed twice per page (/page and /page.html), has no robots.txt or sitemap, carries one meta description on every page, shows a git-describe string as its version (v1.5.0-rc.1-7-g42fa1d4b), and links nowhere to the product site. This fixes what the repository can fix (EN-94, items C1-C5).

What changes

  • C1 docs/_theme/footer.html: every page footer links https://pineforge.dev (both footer branches).
  • C2 new docs/seo_postprocess.py (standard library only; called by docs/build.sh right after Doxygen): adds one rel="canonical" per page (https://cdocs.pineforge.dev/<page>, the landing page as the site root) and rewrites relative page links from X.html to X (index.html to ./, anchors kept). Absolute, mailto:, protocol-relative, root-relative, nested and non-page links, scripts, comments and every non-page file are left alone. Running it twice changes nothing. All pages are validated before any is written; an empty or missing site fails the build.
  • C3 docs/_theme/robots.txt (allow all, names the sitemap) and docs/_theme/404.html are copied to the site root through HTML_EXTRA_FILES (docs/Doxyfile); sitemap.xml is generated from the built pages (sorted, canonical URLs, no 404, no clock data). 404.html is a plain static page (absolute stylesheet links, no scripts) and is left untouched by the post-processing.
  • C4 docs/_theme/header.html: the meta description is built from each page's title; the landing page gets one sentence taken from docs/pages/index.md (the C++17 engine in two layers: a kernel that knows nothing about PineScript or TradingView, and the Pine adapter).
  • C5 docs/build.sh: the version label is the tag name only for a clean checkout of an exact tag, and the word unreleased otherwise.

Please read: C5 (stated)

main is already past the v1.5.0 tag, so the deployed site will read unreleased from the first deploy until the next tag is cut. A build of a tag shows that tag.

Please read: C3 needs a host-side check (not part of this PR; for the site owners)

Today every unknown path on cdocs.pineforge.dev answers 200 with the home page (measured 10-12: /robots.txt, /sitemap.xml, /nonexistent-xyz all 200 text/html). Nothing in this repository produces that; it is host-side configuration of the Cloudflare Pages project pineforge-docs (or whatever fronts the domain), and this PR does not touch Cloudflare. Real files are served correctly (/custom.css 200 text/css), so robots.txt and sitemap.xml will be served as real files after the deploy. For /nonexistent-xyz the decider is
curl -s -o /dev/null -w '%{http_code}\n' https://cdocs.pineforge.dev/nonexistent-xyz:
200 means the host still rewrites unknown paths to /: the change is then to turn off the single-page-app / not-found fallback on the Pages project (in the site owner's Cloudflare account) so the root 404.html is served with status 404. 404 means done.

Notes for the reviewer

  • The sitemap lists every generated top-level page: the docs step built 1143 pages in the lab run, so sitemap.xml has 1142 URLs (well under the 50,000 limit). The ~70 URLs seen in Google's index are a subset.
  • docs/build.sh is a proof-read file, so this PR takes the full CI path (not the documentation-only path). scripts/ci_docs_only.py, scripts/test_ci_docs_only.py and docs/ci.md list docs/seo_postprocess.py next to it. docs/ci.md words changed: "four files a proof job reads" -> "five files" (two places) and the docs/build.sh sentence now names test_docs_seo besides test_docs_doxygen_retry. If this PR is squash-merged, build the squash body from the two commit messages so those namings stay.
  • Why two commits: 0e7a69f7 is the change as reviewed; 9827eaad moves the test_docs_seo registration to the END of tests/CMakeLists.txt, because tests/private_fixture_reads.evidence pins CMake lines by number and a registration in the middle moved a pinned line (the first lab run failed exactly test_private_fixture_reads and test_private_fixture_reads_controls).
  • The self-test (bash docs/build.sh --self-test-seo, CTest row test_docs_seo) runs the real script on a synthetic site and compares the output byte for byte: canonical per page, rewritten and untouched links, escaped descriptions, sitemap URL set, untouched assets, a second pass identical, failure on empty input, the version rule.
  • Order: lands after the corpus gitlink PR corpus: move the gitlink to 9245f28 (probe directories removed, headers state settings only) #376; built on main 2dbd72f; rebased onto Use the shared PineForge favicon in API docs #355 (shared favicon, same HTML_EXTRA_FILES lines) if that lands first.

Verification (lab remote, no tests on the Mac)

  • Job rj-20261012t195837-b0760d (commit 0e7a69f): preflight passed (49 stages, 0 advisory); docs passed (exit 0, Doxygen warnings 0, ==> SEO post-processing: 1143 pages and sitemap.xml). Release, debug, sanitizers, kernel: 2 failures each, test_private_fixture_reads*, fixed by 9827eaa as above.
  • Job rj-20261012t205443-8ec24a (commit 9827eaa, from a worktree of the primary checkout so abi-prior-fetch has its remote): ci_verify release passed, 911 of 911 tests, 38 stages, 0 failures, including test_docs_seo, test_docs_doxygen_retry and test_private_fixture_reads.
  • Job rj-20261012t204300-5f005c (commit 9827eaa): debug exit 0, kernel exit 0; sanitizers: see the PR conversation for the final line.

🤖 Generated with Claude Code

…me (#380, part a)

Part a of #380 (EN-94), split by ENGINE-TOP and L6 so the theme lands first.
This part is the documentation theme only:

- the page footers link https://pineforge.dev (both footer branches);
- docs/_theme/404.html is copied to the site root through HTML_EXTRA_FILES in
  docs/Doxyfile;
- the page template's meta description is built from each page's title instead
  of one sentence on every page.

Part b (docs/build.sh, docs/seo_postprocess.py, scripts/ci_docs_only.py,
scripts/test_ci_docs_only.py, tests/CMakeLists.txt, and with them
docs/_theme/robots.txt, the robots.txt line of docs/Doxyfile and docs/ci.md)
adds the canonical URLs, the sitemap, robots.txt, the version label and the
self-test. robots.txt moves with it because it names the sitemap that only
part b generates.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@luisleo526
luisleo526 merged commit dfdccfc into main Oct 14, 2026
13 checks passed
luisleo526 added a commit that referenced this pull request Oct 17, 2026
* docs: the 1.6.0 release (changelog, current pair, HPO note)

Prepare the final 1.6.0 release documentation dated 2026-10-17, paired with pineforge-codegen 1.6.0 and the matching pineforge-hpo release for selected-window contract revision 1.3.

CHANGELOG.md adds the 1.6.0 — 2026-10-17 entry above 1.6.0-rc.1 — 2026-10-14, carrying forward the release-candidate entry's substance and naming the six documentation and test-only changes merged since v1.6.0-rc.1 (#390, #393, #394, #395, #396, #397).

README.md updates the current-release block and the codegen command-block pointer to 1.6.0 and adds the v1.6.0 bullet to the Releases section. The current-release block's 1.5.0 sentence from 4c78f39 ("The release notes cover recorded outputs, the call-scoped report rule and the test inputs' move to a private repository") is replaced on purpose by the 1.6.0 sentence that lists what 1.6.0 covers; that 1.5.0 summary stays in the Releases list (the v1.5.0 bullet) and in CHANGELOG.md's 1.5.0 entry.

docs/pages/public-contract.md adds the 1.6.0 paragraph after the 1.5.0 paragraph and updates the same-version pairing line to 1.6.0.

* docs: 1.6.0 notes review fixes (HPO pairing line, follow-up figures, value-ownership wording)

The paired-HPO line no longer claims HPO support for selected-window
revision 1.3; HPO 1.6.0 does not implement selected windows
(docs/return-stats.md:9 in pineforge-hpo). The landed follow-ups #396/#397
are said to be checked against their own deliberate bugs, and the figures
remain the candidate's. README.md and docker/README.md replace
"complete value ownership with" by "value ownership through", the wording
of the 1.6.0-rc.1 changelog entry, since no completeness proof was run.
The changelog's no-code-change sentence names the docker/README.md rewording.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>

---------

Co-authored-by: HaoLiangWen <[email protected]>
Co-authored-by: CORE-TOP <[email protected]>
Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
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.

1 participant