Skip to content

Commit fbe6118

Browse files
authored
Merge branch 'dev' into auto-cherry-pick
2 parents 27f1611 + 0c0170e commit fbe6118

File tree

133 files changed

+12798
-10041
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

133 files changed

+12798
-10041
lines changed

.github/workflows/docs-pr-checks.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414

1515
# Generate HTML
1616
docs-build-pr:
17-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.1.2
17+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-build.yml@v1.2.0
1818
with:
1919
deploy-id: ${{ github.event.number }}
2020
retain-artifacts: 14
@@ -24,7 +24,7 @@ jobs:
2424
# By default, the job fails if there are errors, passes if there are warnings only.
2525
docs-verify-pr:
2626
needs: docs-build-pr
27-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.1.2
27+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-verify.yml@v1.2.0
2828
with:
2929
failOnWarnings: true
3030

@@ -41,7 +41,7 @@ jobs:
4141
steps:
4242
- name: Get file changes
4343
id: get-file-changes
44-
uses: tj-actions/changed-files@cbda684547adc8c052d50711417fa61b428a9f88 # v41.1.2
44+
uses: tj-actions/changed-files@2f7c5bfce28377bc069a65ba478de0a74aa0ca32 # v46.0.1
4545
with:
4646
separator: ','
4747
files_yaml: |
@@ -56,7 +56,7 @@ jobs:
5656
docs-updates-comment-pr:
5757
if: needs.docs-build-pr.outputs.pages-listed == 'success'
5858
needs: [docs-build-pr, docs-changes-pr]
59-
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.1.2
59+
uses: neo4j/docs-tools/.github/workflows/reusable-docs-pr-changes.yml@v1.2.0
6060
with:
6161
pages-modified: ${{ needs.docs-changes-pr.outputs.pages-modified }}
6262
pages-added: ${{ needs.docs-changes-pr.outputs.pages-added }}

README.adoc

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
= Neo4j Cypher Manual
22

3+
This page covers the following topics:
4+
5+
* xref:README.adoc#building-locally[]
6+
* xref:README.adoc#raising-prs[]
7+
* xref:README.adoc#documenting-changes[]
8+
* xref:README.adoc#cypher-gql[]
9+
10+
11+
[[building-locally]]
312
== Building locally
413

514
=== Prereqs
@@ -39,7 +48,7 @@ When you run `npm start`, the project is monitored for updates to asciidoc files
3948

4049
If a change to an asciidoc file is detected, the site is automatically rebuilt.
4150

42-
51+
[[raising-prs]]
4352
== Raising PRs
4453

4554

@@ -69,7 +78,6 @@ There are a few edge cases where we might want to work only on the current branc
6978
* When a new version is ready to published, the `5.x` branch will get a git tag, named with the exact version (for example, **5.1.0**), signifying that this point-in-time marks the completion of the work for that minor release.
7079
* Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch.
7180

72-
7381
=== Enable automatic cherry-picking on a PR
7482

7583
To enable automatic cherry-picking on a PR, add the label `auto-cherry-pick` to it.
@@ -98,3 +106,45 @@ The original PR is updated with a comment that contains links to the newly creat
98106
In case of a merge conflict while cherry-picking to a specific release branch, the branch will be skipped. Information on skipped branches is also included in the comment added to the original PR.
99107
In that case you will have to take care of cherry-picking manually and resolve the conflicts.
100108
This is not going to influence the other release branches as long as they do not have conflicts.
109+
110+
111+
[[documenting-changes]]
112+
== Documenting changes to Cypher
113+
114+
New, updated, deprecated, and removed features must be recorded on the xref:modules/ROOT/pages/deprecations-additions-removals-compatibility.adoc[Deprecations, additions, and compatibility] page.
115+
116+
New and deprecated features should also be marked with a label:
117+
118+
* If the impacted feature has its own header in the Cypher Manual, use the following:
119+
120+
....
121+
[role=label--new-5.x]
122+
== Header
123+
....
124+
125+
....
126+
[role=label--deprecated]
127+
== Header
128+
....
129+
130+
* If the impacted feature is documented within a table (such as a return column in a `SHOW` command), use the following:
131+
132+
`featureX` label:new[Introduced in 5.x] +
133+
`featureY` label:deprecated[]
134+
135+
Labels can be difficult to apply to updated features.
136+
In these cases, it is often preferable to note the change in a sentence.
137+
For example: "As of Neo4j 5.x, `featureX` supports ..."
138+
139+
Removed features should be deleted from the Cypher Manual.
140+
141+
[[cypher-gql]]
142+
== Cypher and GQL
143+
144+
When documenting a new Cypher feature, its relationship with GQL must be considered:
145+
146+
* If the feature is part of GQL's mandatory features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-mandatory.adoc[Supported mandatory GQL features].
147+
* If the feature is part of GQL's optional features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-optional.adoc[Supported optional GQL features].
148+
* if the feature adds functionality for which there exists an analogous, optional GQL feature, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/analogous-cypher.adoc[Optional GQL features and analogous Cypher].
149+
* If the feature adds functionality for which there exists no GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc[Additional Cypher features].
150+

antora.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@ nav:
66
- modules/ROOT/content-nav.adoc
77
asciidoc:
88
attributes:
9-
neo4j-version: '5'
10-
neo4j-version-minor: '5.25'
11-
neo4j-version-exact: '5.25.0'
9+
neo4j-version: '2025.05'

modules/ROOT/content-nav.adoc

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
* xref:queries/index.adoc[]
77
** xref:queries/concepts.adoc[]
88
** xref:queries/basic.adoc[]
9-
** xref:queries/expressions.adoc[]
10-
** xref:queries/case.adoc[]
9+
** xref:queries/combined-queries.adoc[]
1110
1211
* xref:clauses/index.adoc[]
1312
** xref:clauses/clause-composition.adoc[]
@@ -31,7 +30,6 @@
3130
** xref:clauses/transaction-clauses.adoc#query-listing-transactions[SHOW TRANSACTIONS]
3231
** xref:clauses/skip.adoc[]
3332
** xref:clauses/transaction-clauses.adoc#query-terminate-transactions[TERMINATE TRANSACTIONS]
34-
** xref:clauses/union.adoc[]
3533
** xref:clauses/unwind.adoc[]
3634
** xref:clauses/use.adoc[]
3735
** xref:clauses/where.adoc[]
@@ -52,16 +50,32 @@
5250
** xref:patterns/non-linear-patterns.adoc[]
5351
** xref:patterns/reference.adoc[]
5452
55-
5653
* xref:values-and-types/index.adoc[]
57-
** xref:values-and-types/property-structural-constructed.adoc[]
58-
** xref:values-and-types/temporal.adoc[]
59-
** xref:values-and-types/spatial.adoc[]
60-
** xref:values-and-types/working-with-null.adoc[]
61-
** xref:values-and-types/lists.adoc[]
62-
** xref:values-and-types/maps.adoc[]
63-
** xref:values-and-types/casting-data.adoc[]
64-
** xref:values-and-types/type-predicate.adoc[]
54+
** xref::values-and-types/property-structural-constructed.adoc[]
55+
** xref:values-and-types/boolean-numeric-string.adoc[]
56+
** xref::values-and-types/temporal.adoc[]
57+
** xref::values-and-types/spatial.adoc[]
58+
** xref::values-and-types/lists.adoc[]
59+
** xref::values-and-types/maps.adoc[]
60+
** xref::values-and-types/working-with-null.adoc[]
61+
** xref::values-and-types/casting-data.adoc[]
62+
** xref:values-and-types/ordering-equality-comparison.adoc[]
63+
64+
* xref:expressions/index.adoc[]
65+
** xref:expressions/predicates/index.adoc[]
66+
*** xref:expressions/predicates/boolean-operators.adoc[]
67+
*** xref:expressions/predicates/comparison-operators.adoc[]
68+
*** xref:expressions/predicates/list-operators.adoc[]
69+
*** xref:expressions/predicates/string-operators.adoc[]
70+
*** xref:expressions/predicates/path-pattern-expressions.adoc[]
71+
*** xref:expressions/predicates/type-predicate-expressions.adoc[]
72+
** xref:expressions/node-relationship-operators.adoc[]
73+
** xref:expressions/mathematical-operators.adoc[]
74+
** xref:expressions/string-operators.adoc[]
75+
** xref:expressions/temporal-operators.adoc[]
76+
** xref:expressions/list-expressions.adoc[]
77+
** xref:expressions/map-expressions.adoc[]
78+
** xref:expressions/conditional-expressions.adoc[]
6579
6680
* xref:functions/index.adoc[]
6781
** xref:functions/aggregating.adoc[]
@@ -81,7 +95,6 @@
8195
** xref:functions/user-defined.adoc[]
8296
** xref:functions/vector.adoc[]
8397
84-
8598
* xref:genai-integrations.adoc[]
8699
* xref:indexes/index.adoc[]
87100
** xref:indexes/search-performance-indexes/overview.adoc[]
@@ -116,9 +129,8 @@
116129
** xref:syntax/parsing.adoc[]
117130
** xref:syntax/naming.adoc[]
118131
** xref:syntax/variables.adoc[]
119-
** xref:syntax/reserved.adoc[]
132+
** xref:syntax/keywords.adoc[]
120133
** xref:syntax/parameters.adoc[]
121-
** xref:syntax/operators.adoc[]
122134
** xref:syntax/comments.adoc[]
123135
124136
* xref:deprecations-additions-removals-compatibility.adoc[]
Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)