Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions .github/workflows/docs-deploy-surge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ on:
- completed

jobs:
publish-docs:
deploy-docs:
# Uncomment this if statement to deploy only when the PR builds cleanly
# if: github.event.workflow_run.conclusion == 'success'

Expand Down Expand Up @@ -63,11 +63,6 @@ jobs:
- id: unzip-docs
run: unzip docs.zip

- id: get-top-dir
run: |
root=$(ls -d */index.html | sed -r 's/(.*)\/index\.html/\1/')
echo "top-dir=$root" >> $GITHUB_OUTPUT

- id: unzip-changelog
if: ${{ hashFiles('changelog.zip') != '' }}
run: unzip changelog.zip
Expand Down Expand Up @@ -99,13 +94,13 @@ jobs:
SITE_DIR: ${{ steps.get-top-dir.outputs.top-dir }}
run: |
npm install -g surge
surge ./$SITE_DIR $DEPLOY_URL --token "$SURGE_TOKEN"
surge . $DEPLOY_URL --token "$SURGE_TOKEN"

# If the PR artifacts include a changelog file, add it to the PR as a comment
# The changelog contains links to new and changed files in the deployed docs
- name: Comment on PR (changelog)
if: ${{ hashFiles('changelog') != '' }}
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0
uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2
with:
number: ${{ steps.get-deploy-id.outputs.deploy-id }}
recreate: true
Expand All @@ -118,12 +113,12 @@ jobs:
if: ${{ hashFiles('changelog') == '' }}
env:
DEPLOY_URL: ${{ steps.get-deploy-url.outputs.deploy-url }}
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0
uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2
with:
number: ${{ steps.get-deploy-id.outputs.deploy-id }}
header: docs-pr-changes
message: |
Looks like you've updated the documentation!

Check out your changes at https://${{ env.DEPLOY_URL }}
GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }}
GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }}
14 changes: 7 additions & 7 deletions .github/workflows/docs-pr-checks.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

name: "Verify Docs PR"
name: "Verify docs PR"

on:
pull_request:
Expand All @@ -12,7 +12,7 @@ jobs:

# Generate HTML
docs-build-pr:
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.2.0
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v2
with:
deploy-id: ${{ github.event.number }}
retain-artifacts: 14
Expand All @@ -22,7 +22,7 @@ jobs:
# By default, the job fails if there are errors, passes if there are warnings only.
docs-verify-pr:
needs: docs-build-pr
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.2.0
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v2
with:
failOnWarnings: true

Expand All @@ -44,17 +44,17 @@ jobs:
separator: ','
files_yaml: |
pages:
- modules/**/pages/**/*.adoc
- '**/modules/**/pages/**/*.adoc'
asciidoc:
- modules/**/*.adoc
- '**/modules/**/*.adoc'

# Generate a PR comment if the docs are using the pageList extension
# The extension maps asciidoc source files to their HTML output paths
# The comment will contain links to new and changed pages in the deployed HTML docs
docs-updates-comment-pr:
if: needs.docs-build-pr.outputs.pages-listed == 'success'
needs: [docs-build-pr, docs-changes-pr]
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.2.0
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v2
with:
pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }}
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}
7 changes: 3 additions & 4 deletions .github/workflows/docs-teardown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
- "dev"
- "cypher-25"
- "cypher-5"

types:
- closed

Expand All @@ -16,7 +15,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: lts/*

Expand All @@ -39,7 +38,7 @@ jobs:
surge teardown $DEPLOY_URL --token "$SURGE_TOKEN"

- name: Comment on PR
uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 # v2.9.0
uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #v2
with:
number: ${{ github.event.pull_request.number }}
header: docs-pr-changes
Expand All @@ -48,4 +47,4 @@ jobs:

The preview documentation has now been torn down - reopening this PR will republish it.
GITHUB_TOKEN: ${{ secrets.DOCS_PR_COMMENT_TOKEN }}


Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Either the pattern already exists, or it needs to be created.
| xref:values-and-types/spatial.adoc[`POINT` values]
| Spatial values.

| xref:values-and-types/maps.adoc#query-operators-list[`MAP` values].
| xref:values-and-types/maps.adoc[`MAP` values].
| Map values - the GQL equivalent is Records.

|===
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/expressions/list-expressions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ RETURN [1, 2] || [3, null] AS listWithNull
1+d|Rows: 1
|===

For removing `null` values when concatenating `LIST` values, see xref:expressions/list-expressions.adoc#null-list-concatenation-list-comprehension[`null`, list concatenation, and list comprehension].
For removing `null` values when concatenating `LIST` values, see xref:expressions/list-expressions.adoc#list-comprehension[List comprehension].

[[add-elements]]
== Add elements to a list
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -264,12 +264,12 @@ WITH {name: 'William Shakespeare'} AS varName
MERGE (:PointOfInterest {name: toString(varName.name)})
----

For information about how to ensure the use of text indexes when predicates may contain `null` values, see xref:indexes/search-performance-indexes/using-indexes/indexes-and-null[Indexes and `null` values].
For information about how to ensure the use of text indexes when predicates may contain `null` values, see xref:indexes/search-performance-indexes/using-indexes.adoc#indexes-and-null[Indexes and `null` values].

[[text-index-string-size]]
=== Text indexes and `STRING` sizes

The size of the indexed `STRING` properties is also relevant to the planners selection between range and text indexes.
The size of the indexed `STRING` properties is also relevant to the planner's selection between range and text indexes.

Range indexes have a maximum key size limit of around 8 kb.
This means that range indexes cannot be used to index `STRING` values larger than 8 kb.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/values-and-types/vector.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
= Vectors
:description: Create and store vectors (embeddings) as properties on nodes and relationships, and use them for efficient semantic retrieval with vector indexes and the GenAI plugin.
:page-role: new-neo4j-2025.10 enterprise-edition
Expand Down Expand Up @@ -103,7 +103,7 @@
- `VECTOR` with only a defined coordinate type is a supertype of all `VECTOR` values with that coordinate type, regardless of the dimension.
For example, `VECTOR<INT>` is a supertype of `VECTOR<INT>(3)` and `VECTOR<INT>(1024)`.

All of these supertypes can be used in xref:expressions/predicates/type-predicate-expressions.adoc#type-predicate-vector[type predicate expressions].
All of these supertypes can be used in xref:expressions/predicates/type-predicate-expressions.adoc[type predicate expressions].
For more information, see:

* xref:values-and-types/ordering-equality-comparison.adoc#ordering-and-comparison[Equality, ordering, and comparison of value types -> Ordering vector types]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/values-and-types/working-with-null.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The xref::expressions/predicates/boolean-operators.adoc[boolean operators] (`AND
[[cypher-null-in-operator]]
== The `IN` operator and `null`

The xref:expressions/predicates/list-operators[`IN` operator] follows similar logic.
The xref:expressions/predicates/list-operators.adoc[`IN` operator] follows similar logic.
If Cypher can ascertain that something exists in a list, the result will be `true`.
Any list that contains a `null` and does not have a matching element will return `null`.
Otherwise, the result will be `false`.
Expand Down
17 changes: 10 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@
"main": "server.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "nodemon -e adoc --exec \"npm run build && npm run serve\"",
"prestart": "npm update",
"start": "nodemon -e adoc --exec \"npm run build\"",
"serve": "node server.js",
"adoc-gen": "node scripts/adoc-gen.js",
"build": "antora preview.yml --stacktrace --log-format=pretty",
"build-verify": "antora --stacktrace --fetch preview.yml --log-format=json --log-level=info --log-file ./build/log/log.json",
"publish-verify": "antora --stacktrace --fetch publish.yml --log-format=json --log-file ./build/log/log.json"
"clean": "rm -rf build",
"build": "npm run build:preview",
"postbuild": "node server.js",
"build:preview": "antora preview.yml --stacktrace --log-format=pretty",
"build:publish": "npm run clean && antora publish.yml --stacktrace --log-format=pretty",
"verify:preview": "antora --stacktrace --fetch preview.yml --log-format=json --log-level=info --log-file ./build/log/log.json",
"verify:publish": "antora --stacktrace --fetch publish.yml --log-format=json --log-level=info --log-file ./build/log/log.json"
},
"keywords": [
"antora",
Expand All @@ -19,15 +23,14 @@
"author": "Neo4j",
"license": "ISC",
"dependencies": {
"@antora/cli": "^3.1.10",
"@antora/site-generator-default": "^3.1.10",
"@neo4j-antora/antora-add-notes": "^0.3.2",
"@neo4j-antora/antora-modify-sitemaps": "^0.7.1",
"@neo4j-antora/antora-page-roles": "^0.3.1",
"@neo4j-antora/antora-table-footnotes": "^0.3.3",
"@neo4j-antora/mark-terms": "1.1.0",
"@neo4j-documentation/macros": "^1.0.4",
"@neo4j-documentation/remote-include": "^1.0.0",
"antora": "3.1.14",
"asciidoctor-kroki": "^0.18.1"
},
"devDependencies": {
Expand Down
5 changes: 4 additions & 1 deletion preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,16 @@ ui:
urls:
html_extension_style: indexify

antora:
extensions:
- "@neo4j-antora/table-footnotes"

asciidoc:
extensions:
- "@neo4j-documentation/remote-include"
- "@neo4j-documentation/macros"
- "@neo4j-antora/antora-add-notes"
- "@neo4j-antora/antora-page-roles"
- "@neo4j-antora/antora-table-footnotes"
- "@neo4j-antora/mark-terms"
- asciidoctor-kroki
attributes:
Expand Down
5 changes: 4 additions & 1 deletion publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,16 @@ ui:
urls:
html_extension_style: indexify

antora:
extensions:
- "@neo4j-antora/table-footnotes"

asciidoc:
extensions:
- "@neo4j-documentation/remote-include"
- "@neo4j-documentation/macros"
- "@neo4j-antora/antora-add-notes"
- "@neo4j-antora/antora-page-roles"
- "@neo4j-antora/antora-table-footnotes"
- "@neo4j-antora/mark-terms"
- asciidoctor-kroki
attributes:
Expand Down
Loading