Repository navigation
docs: fix the broken cross-references and anchor names that fail Documentation Validation - #515
Conversation
|
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. |
|
With this change
They come from markup inside the sources (a |
… 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>
0989039 to
457e662
Compare
|
CI is green now. The "Validate HTML output" step (html5validator on the single-page build of |
|
@claude review this |
|
Super |
Documentation Validationfails 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.pypasses 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 inconcepts/transactions.adocgets[[statement-fails-halfway]].reference/sql/chapter.adoc:<<vector-neighbours,...>>, the anchor is spelledvector-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#cchShortestPathor#duanSSSPwould need the new names.🤖 Generated with Claude Code