Skip to content

docs: fix the broken cross-references and anchor names that fail Documentation Validation - #515

Merged
lvca merged 3 commits into
ArcadeData:mainfrom
tae898:docs/fix-broken-xrefs
Nov 5, 2026
Merged

lvca merged 3 commits into
ArcadeData:mainfrom
tae898:docs/fix-broken-xrefs

Conversation

@tae898

@tae898 tae898 commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Documentation Validation fails on main (the latest runs and every open PR, e.g. #511) with three broken cross-references and two anchor names outside the lowercase-with-hyphens convention. This fixes all five; python docs-validator.py passes locally.

  • how-to/connectivity/postgres.adoc: <<Column type mapping,...>> pointed at a section title, which the validator does not resolve; the section gets [[postgres-column-type-mapping]] and the reference uses it.
  • reference/settings.adoc: <<_a_statement_that_fails_halfway>> relied on the generated section id; the section in concepts/transactions.adoc gets [[statement-fails-halfway]].
  • reference/sql/chapter.adoc: <<vector-neighbours,...>>, the anchor is spelled vector-neighbors.
  • reference/sql/sql-functions.adoc: [[cchShortestPath]] and [[duanSSSP]] become [[cch-shortest-path]] and [[duan-sssp]], like the other function anchors ([[both-v]]); the three references to the first are updated (graph-olap.adoc, path-finding.adoc, sql-functions.adoc). Links from outside the docs to #cchShortestPath or #duanSSSP would need the new names.

🤖 Generated with Claude Code

@mergify

mergify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

This pull request does not currently match the merge queue conditions, so it cannot be queued from here. The box comes back if it matches again.

@tae898

tae898 commented Oct 30, 2026

Copy link
Copy Markdown
Contributor Author

With this change python docs-validator.py passes in CI too ("Documentation passed all validation checks"). The job is still red at its next step, the HTML check of the generated site, which main never reached because the validator failed first: 21 errors, all in the generated index.html.

count error
15 No "code" element in scope but a "code" end tag seen.
2 Stray end tag "mark".
1 The string following "&" was interpreted as a character reference. ("&" probably should have been escaped as "&".)
1 Bad value "file://exports/" for attribute "href" on element "a": Illegal character in path segment: "<" is not allowed.
1 Named character reference was not terminated by a semicolon. (Or "&" should have been escaped as "&".)
1 Stray end tag "sub".

They come from markup inside the sources (a #, ~ or & read as formatting or an entity inside monospace text, an <file-name> placeholder in a link) and need a site build to map back to their lines, so I left them for a separate PR to keep this one to the validator.

tae898 and others added 3 commits November 5, 2026 10:58
… fail Documentation Validation

- postgres.adoc: <<Column type mapping,...>> pointed at a section title; the
  section gets [[postgres-column-type-mapping]].
- settings.adoc: <<_a_statement_that_fails_halfway>> relied on the generated
  id; the section in transactions.adoc gets [[statement-fails-halfway]].
- sql/chapter.adoc: <<vector-neighbours,...>> -> the anchor is vector-neighbors.
- sql-functions.adoc: [[cchShortestPath]] and [[duanSSSP]] -> cch-shortest-path
  and duan-sssp (lowercase with hyphens), with the three references updated.

docs-validator.py passes locally (it failed on main with these five).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…iteral monospace

The "Validate HTML output" step (html5validator on the single-page build,
target/generated-docs/index.html) failed with 21 errors, on main as well.
Asciidoctor applies strong, emphasis, mark and subscript before monospace,
so a pair of `*` (or `_`, `#`, `~`) in two different backtick spans pairs up
across them: `wal.group.*` and `commit.lock.*` rendered as
<code>wal.group.<strong></code> and <code>commit.lock.</strong></code>,
which is a stray "code" end tag, and `=~`/`!~` and `#` did the same with
sub and mark. `file://exports/<file-name>` was turned into a bare link with
an illegal href. The same markup renders the live pages wrong (bold running
over the text between two code spans), so the fix is in the sources.

Each affected span is now `+...+` literal monospace, the form sql-projections.adoc
already used. Only spans in the paragraphs that rendered wrongly changed.
Checked by rendering index.adoc with Asciidoctor 3 and scanning for
misnested code/strong/em/mark/sub tags (80 before, 0 after); the real
html5validator run is the CI step.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
main moved by about 130 commits; two new things would fail the same two
CI steps again. The anchor [[util-validatePredicate]] (utility.adoc) is
renamed util-validate-predicate, the lowercase-with-hyphens form the
validator requires (nothing refers to it). In redis.adoc, `*1\r\n:1\r\n`
and `'*'` paired as strong across the two code spans, giving a stray
"code" end tag in the single-page build; both are literal monospace now.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898
tae898 force-pushed the docs/fix-broken-xrefs branch from 0989039 to 457e662 Compare November 5, 2026 01:59
@tae898

tae898 commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

CI is green now. The "Validate HTML output" step (html5validator on the single-page build of src/main/asciidoc/index.adoc) failed with 21 errors that main has too; main never got that far because the validator step failed first. The cause was in the sources: Asciidoctor applies strong, emphasis, mark and subscript before monospace, so a *, _, # or ~ in two different backtick spans paired up across them (for example `wal.group.*` and `commit.lock.*` rendered as <code>wal.group.<strong></code> and <code>commit.lock.</strong></code>). The same markup also rendered the live pages wrong (bold running across code spans). The affected spans, in 23 files, are now literal monospace (`+...+`, the form sql-projections.adoc already used), plus an anchor renamed and two spans in redis.adoc that main gained since this PR was opened. No check was loosened or skipped. Ready for review whenever you have a moment; happy to adjust.

@lvca

lvca commented Nov 5, 2026

Copy link
Copy Markdown
Member

@claude review this

@lvca
lvca merged commit 457e662 into ArcadeData:main Nov 5, 2026
4 checks passed
@tae898
tae898 deleted the docs/fix-broken-xrefs branch November 5, 2026 04:59
@lvca

lvca commented Nov 5, 2026

Copy link
Copy Markdown
Member

Super

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