Repository navigation
docs(seo): page titles, release version attribute, thin index pages - #531
Merged
Merged
Conversation
From the 2026-11-12 SEO audit of docs.arcadedb.com. - Give the six chapter pages that rendered as "Untitled" a title and H1 (GraphQL, Gremlin, Java API, MongoDB QL, Redis, Studio). The heading is wrapped in ifdef::site-gen-antora[] where the included page already supplies it, so the PDF and single-page build do not get a duplicate. - Retitle the Cypher clauses page from "MATCH" to "Cypher Clauses Reference" and the Python tutorial to "ArcadeDB Python Quickstart", with a description that leads with the official arcadedb-driver. - Make one-word and duplicate titles specific (Docker, Kubernetes, Vector Search, SQL Reference, the Connecting from <language> pages, ...) and drop the em dash from the driver page titles. - version.adoc is now the one place to set the release: migrate.sh syncs it into docs/antora.yml and generate-pdf-manual.py reads it. Bumped to 26.11.1, so the Docker, Maven and binary snippets show the current release. - Remove core-concepts/chapter, a 14-word duplicate of concepts/chapter that nothing linked to; 301 it to concepts/chapter. - Add an orientation paragraph to the How-To Guides landing page and say LSM_VECTOR instead of HNSW on the vector tutorial cards. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
|
This pull request is merged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs-side content fixes from the 2026-11-12 SEO audit of docs.arcadedb.com. A second PR (#532) adds the structured data and build steps; the two don't depend on each other.
Changes
Untitled chapter pages (audit item 1). These six pages now have a
<title>and an H1: GraphQL, Gremlin, Java API, MongoDB QL, Redis and Studio. For the four query-language chapters and Studio, the included page already supplies the heading in the PDF and single-page build. So the new heading is wrapped inifdef::site-gen-antora[]and only Antora sees it. Java API had no heading at all, and its sections were out of sequence in the PDF, so it gets a real=== Java API Reference.Titles (item 2).
reference/cypher/cypher-clauses: "MATCH" becomes "Cypher Clauses Reference". The==== Clauses Referenceheading and thecypher-commandsanchor move fromcypher/chapter.adocinto the page, so the PDF structure doesn't change.tutorials/python-quickstart: "Python" becomes "ArcadeDB Python Quickstart". It gets a hand-written description that leads with the officialarcadedb-driver.Driver titles drop the
--em dash ("Go gRPC Driver", "Python HTTP Driver", ...).One-word and duplicate titles are made specific:
Sidebar labels are set in
generate-nav.pyand mostly stay short.Release version (item 3). The
{revnumber}attribute already existed and is used by every install and run snippet (Docker, Maven, binaries, native image). It was defined in four places with three different values:version.adocantora.ymlpom.xmlgenerate-pdf-manual.pyNow
src/main/asciidoc/version.adocis the one place to set it. The newscripts/sync-revnumber.py(amigrate.shstep) copies it intodocs/antora.yml, andgenerate-pdf-manual.pyreads it. The value is bumped to 26.11.1. "Since vX" notes are untouched.Thin pages and wording (item 8).
core-concepts/chapterwas a 14-word duplicate ofconcepts/chapter. Its includes pointed at files that don't exist in that folder, and nothing linked to it. It is removed and 301'd toconcepts/chapterin_redirects.LSM_VECTORinstead of HNSW.Skipped (checked against source)
api-integrationandlanguages-driversalready open with a summary hero and a full set of cards. They aren't thin, so they're left alone.Verification
migrate.sh+npm run build: Antora prints exactly the same warnings as on main (diffed).<title>and H1.arcadedata/arcadedb:26.11.1.mvn generate-resources(legacy build) succeeds with no new warnings, and the ifdef'd headings don't appear in it.python docs-validator.pypasses.🤖 Generated with Claude Code