Update README to include documenting changes to language and GQL #1100
Conversation
JPryce-Aklundh
changed the title
README.adoc
Outdated
| * xref:README.adoc#cypher-gql[] | ||
| [[build-locally]] |
There was a problem hiding this comment.
not sure these have to be set
asciidoc generates anchors for headings by default - it should be #building-locally for the line below
edit: just noticed, on github, both anchors are present now (eg https://github.com/JPryce-Aklundh/docs-cypher/tree/updated_readme?tab=readme-ov-file#documenting-changes and https://github.com/JPryce-Aklundh/docs-cypher/tree/updated_readme?tab=readme-ov-file#documenting-changes-to-cypher)
README.adoc
Outdated
| [role=label--new-5.x] | ||
| \== Header |
There was a problem hiding this comment.
source block missing, this doesn't render correctly:
https://github.com/JPryce-Aklundh/docs-cypher/tree/updated_readme?tab=readme-ov-file#documenting-changes-to-cypher
README.adoc
Outdated
| [role=label--deprecated] | ||
| \== Header |
| `featureX` label:new[Introduced in 5.x] + | ||
| `featureY` label:deprecated[] |
There was a problem hiding this comment.
these work, but i guess they could use a source block as well
README.adoc
Outdated
| In these cases, it is often preferable to note the change in a sentence. | ||
| For example: "As of Neo4j 5.x, featureX supports ..." | ||
|
|
||
| Removed features should be removed from the Cypher Manual. |
There was a problem hiding this comment.
I'm a fan of imperative mood for this (usually shorter)
"remove removed ..." isn't exactly elegant though :D
README.adoc
Outdated
|
|
||
| * 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[]. | ||
| * 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[]. | ||
| * if the feature adds functionality for which there exists an analogous GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/analogous-cypher.adoc[]. |
There was a problem hiding this comment.
"analogous GQL equivalent" - is it analogous or equivalent? their use might be synonymous in this context, but then we only need one 🤔
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
3 participants
No description provided.