Skip to content

docs(seo): page titles, release version attribute, thin index pages - #531

Merged
robfrank merged 2 commits into
mainfrom
docs/seo-titles-versions
Nov 12, 2026
Merged

robfrank merged 2 commits into
mainfrom
docs/seo-titles-versions

Conversation

@robfrank

@robfrank robfrank commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

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 in ifdef::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 Reference heading and the cypher-commands anchor move from cypher/chapter.adoc into 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 official arcadedb-driver.

  • Driver titles drop the -- em dash ("Go gRPC Driver", "Python HTTP Driver", ...).

  • One-word and duplicate titles are made specific:

    • "Running ArcadeDB with Docker" and "Running ArcadeDB on Kubernetes"
    • "Vector Search"
    • "SQL Reference" and "SQL Introduction"
    • "SQL Indexes" and "SQL Materialized Views"
    • "Java Schema API"
    • "Configuring High Availability"
    • "Connecting from C / C# / Elixir / R / Ruby / Rust"
    • "ArcadeDB Go Quickstart" and "ArcadeDB Java Tutorial"
    • "MongoDB Query Language" and "Redis Protocol"

    Sidebar labels are set in generate-nav.py and 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:

File Value
version.adoc 26.10.1
antora.yml 26.10.2
pom.xml 26.10.2
generate-pdf-manual.py 26.10.2

Now src/main/asciidoc/version.adoc is the one place to set it. The new scripts/sync-revnumber.py (a migrate.sh step) copies it into docs/antora.yml, and generate-pdf-manual.py reads it. The value is bumped to 26.11.1. "Since vX" notes are untouched.

Thin pages and wording (item 8).

  • core-concepts/chapter was a 14-word duplicate of concepts/chapter. Its includes pointed at files that don't exist in that folder, and nothing linked to it. It is removed and 301'd to concepts/chapter in _redirects.
  • The How-To Guides landing page gets an orientation paragraph.
  • The vector tutorial cards on the home and Get Started pages say LSM_VECTOR instead of HNSW.

Skipped (checked against source)

  • api-integration and languages-drivers already open with a summary hero and a full set of cards. They aren't thin, so they're left alone.
  • No arcadedb-component page is titled just "Quickstart". It's probably in the arcadedb-python component, which lives in another repo.
  • The Academy card ("Embeddings, HNSW indexes, ...") describes the external Academy course, so it's left as is.

Verification

  • migrate.sh + npm run build: Antora prints exactly the same warnings as on main (diffed).
  • No page is titled "Untitled", and each changed page has the expected <title> and H1.
  • The Docker page renders 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.py passes.

🤖 Generated with Claude Code

robfrank and others added 2 commits November 12, 2026 16:10
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>
@mergify

mergify Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

This pull request is merged.

@robfrank
robfrank merged commit 51fada9 into main Nov 12, 2026
4 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.

1 participant