Review of type definitions, directives and schema configuration sections (#22)

* review

* update

* fixing broken links

* bringing back reference to the api reference page

* Fix incorrect references to variables in Cypher (#17)

* Remove references to deprecated directives (#11)

Co-authored-by: Lidia Zuin <[email protected]>

* Remove references to deprecated directives (#11)

Co-authored-by: Lidia Zuin <[email protected]>

* Update `@queryOptions` to `@limit` and add migration step (#19)

* review

* fixing broken links

* Remove references to deprecated directives (#11)

Co-authored-by: Lidia Zuin <[email protected]>

* Remove references to deprecated directives (#11)

Co-authored-by: Lidia Zuin <[email protected]>

* Update `@queryOptions` to `@limit` and add migration step (#19)

* fixing broken links

* Remove references to deprecated directives (#11)

Co-authored-by: Lidia Zuin <[email protected]>

* Update `@queryOptions` to `@limit` and add migration step (#19)

* fixing conflict

* fixing links

* final update

* Restructure

* Fix broken references

* More broken references

* Final broken references

---------

Co-authored-by: Darrell Warde <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

Author: lidiazuin

modules/ROOT/content-nav.adoc

@@ -3,11 +3,36 @@
 ** xref:getting-started/index.adoc[]
 *** xref:getting-started/toolbox.adoc[]
 
+** Type definitions
+*** xref:type-definitions/types/index.adoc[]
+**** xref:type-definitions/types/scalar.adoc[Scalar]
+**** xref:type-definitions/types/temporal.adoc[Temporal]
+**** xref:type-definitions/types/spatial.adoc[Spatial]
+**** xref:type-definitions/types/interfaces.adoc[Interface]
+**** xref:type-definitions/types/unions.adoc[Union]
+**** xref:type-definitions/types/relationships.adoc[]
+*** xref:type-definitions/directives/index.adoc[]
+**** xref:type-definitions/directives/basics.adoc[]
+**** xref:type-definitions/directives/autogeneration.adoc[]
+**** xref:type-definitions/directives/custom-directives.adoc[]
+**** xref:type-definitions/directives/cypher.adoc[]
+**** xref:type-definitions/directives/default-values.adoc[]
+**** xref:type-definitions/directives/database-mapping.adoc[]
+**** xref:type-definitions/directives/indexes-and-constraints.adoc[]
+
+** xref:schema-configuration/index.adoc[Schema configuration]
+*** xref:schema-configuration/type-configuration.adoc[]
+*** xref:schema-configuration/global-configuration.adoc[]
+*** xref:schema-configuration/field-configuration.adoc[]
+
 ** xref:queries-aggregations/index.adoc[Queries and aggregations]
 *** xref:queries-aggregations/queries.adoc[]
 *** xref:queries-aggregations/aggregations.adoc[]
 *** xref:queries-aggregations/filtering.adoc[]
 *** xref:queries-aggregations/sorting.adoc[]
+*** xref:queries-aggregations/pagination/index.adoc[]
+**** xref:queries-aggregations/pagination/offset-based.adoc[]
+**** xref:queries-aggregations/pagination/cursor-based.adoc[]
 
 ** xref:mutations/index.adoc[]
 *** xref:mutations/create.adoc[]
@@ -23,10 +48,6 @@
 
 ** xref:custom-resolvers.adoc[]
 
-** xref:pagination/index.adoc[]
-*** xref:pagination/offset-based.adoc[]
-*** xref:pagination/cursor-based.adoc[]
-
 ** xref:authentication-and-authorization/index.adoc[]
 *** xref:authentication-and-authorization/configuration.adoc[]
 *** xref:authentication-and-authorization/authentication.adoc[]
@@ -50,31 +71,7 @@
 *** xref:ogm/type-generation.adoc[]
 *** xref:ogm/reference.adoc[]
 
-** Reference
-*** xref:reference/api-reference/index.adoc[]
-**** xref:reference/api-reference/neo4jgraphql.adoc[]
-**** xref:reference/api-reference/ogm.adoc[]
-*** xref:reference/type-definitions/index.adoc[]
-**** xref:reference/type-definitions/indexes-and-constraints.adoc[]
-**** xref:reference/type-definitions/interfaces.adoc[]
-**** xref:reference/type-definitions/relationships.adoc[]
-**** xref:reference/type-definitions/types.adoc[]
-**** xref:reference/type-definitions/unions.adoc[]
-
-*** xref:reference/directives/index.adoc[]
-**** xref:reference/directives/schema-configuration/index.adoc[]
-***** xref:reference/directives/schema-configuration/type-configuration.adoc[]
-***** xref:reference/directives/schema-configuration/global-configuration.adoc[]
-***** xref:reference/directives/schema-configuration/field-configuration.adoc[]
-
-**** xref:reference/directives/autogeneration.adoc[]
-**** xref:reference/directives/basics.adoc[]
-**** xref:reference/directives/custom-directives.adoc[]
-**** xref:reference/directives/cypher.adoc[]
-**** xref:reference/directives/default-values.adoc[]
-**** xref:reference/directives/database-mapping.adoc[]
-
-*** xref:reference/driver-configuration.adoc[]
+*** xref:driver-configuration.adoc[]
 
 ** Frameworks and integrations
 *** xref:integrations/apollo-federation.adoc[]

modules/ROOT/pages/reference/driver-configuration.adoc renamed to modules/ROOT/pages/driver-configuration.adoc

@@ -23,13 +23,13 @@ It can generate an entire executable schema with all of the additional types nee
 For every query and mutation that is executed against this generated schema, the Neo4j GraphQL Library generates a single Cypher query which is executed against the database. This eliminates the https://www.google.com/search?q=graphql+n%2B1[N+1 Problem], which can make GraphQL implementations slow and inefficient.
 
 - Automatic generation of xref::queries-aggregations/queries.adoc[Queries] and xref::mutations/index.adoc[Mutations] for CRUD interactions.
-- xref::reference/type-definitions/types.adoc[Types], including temporal and spatial.
+- xref::/type-definitions/types/index.adoc[Types], including temporal and spatial.
 - Support for both node and relationship properties.
-- Extensibility through the xref::reference/directives/cypher.adoc[`@cypher` directive] and/or xref::custom-resolvers.adoc[Custom Resolvers].
+- Extensibility through the xref::/type-definitions/directives/cypher.adoc[`@cypher` directive] and/or xref::custom-resolvers.adoc[Custom Resolvers].
 - Extensive xref::queries-aggregations/filtering.adoc[Filtering] and xref::queries-aggregations/sorting.adoc[Sorting] options.
-- Options for value xref::reference/directives/autogeneration.adoc[Autogeneration] and xref::reference/directives/default-values.adoc[Default Values].
-- xref::pagination/index.adoc[Pagination] options.
-- xref::authentication-and-authorization/index.adoc[Authentication and authorization options] and additional xref::reference/directives/schema-configuration/index.adoc[Schema Configuration].
+- Options for value xref::/type-definitions/directives/autogeneration.adoc[Autogeneration] and xref::/type-definitions/directives/default-values.adoc[Default Values].
+- xref::/queries-aggregations/pagination/index.adoc[Pagination] options.
+- xref::authentication-and-authorization/index.adoc[Authentication and authorization options] and additional xref::schema-configuration/index.adoc[Schema Configuration].
 - An xref::ogm/index.adoc[OGM] (Object Graph Mapper) for programmatic interaction with your GraphQL API.
 - A xref::getting-started/toolbox.adoc[Toolbox] (UI) to experiment with your Neo4j GraphQL API on Neo4j Desktop.
 

modules/ROOT/pages/index.adoc

@@ -97,7 +97,7 @@ type NameOfTypeToExclude @exclude {
   name: String
 }
 ----
-For more information regarding the above used `@exclude` directive, see xref::reference/directives/schema-configuration/type-configuration.adoc#_exclude_deprecated[`@exclude`]
+For more information regarding the above used `@exclude` directive, see xref::/schema-configuration/type-configuration.adoc#_exclude_deprecated[`@exclude`]
 
 === Database Configuration
 
@@ -153,7 +153,7 @@ server.listen().then(({ url }) => {
 });
 ----
 
-Database bookmarks are also supported. See xref::reference/driver-configuration.adoc[Driver Configuration] for more information.
+Database bookmarks are also supported. See xref::driver-configuration.adoc[Driver Configuration] for more information.
 
 [[migration-guide-type-definitions]]
 == Type Definitions
@@ -173,7 +173,7 @@ Migrating this directive is trivial:
 
 For example, `@relation(name: "ACTED_IN", direction: OUT)` becomes `@relationship(type: "ACTED_IN", direction: OUT)`.
 
-See xref::reference/type-definitions/relationships.adoc[Relationships] for more information on relationships in `@neo4j/graphql`.
+See xref::/type-definitions/types/relationships.adoc[Relationships] for more information on relationships in `@neo4j/graphql`.
 
 ==== Relationship Properties
 
@@ -226,13 +226,13 @@ And note the following changes to the two node types:
 
 === `@cypher`
 
-No change. See xref::reference/directives/cypher.adoc[`@cypher` directive] for more details on this directive in `@neo4j/graphql`.
+No change. See xref::/type-definitions/directives/cypher.adoc[`@cypher` directive] for more details on this directive in `@neo4j/graphql`.
 
 ==== `@neo4j_ignore`
 
 `@neo4j/graphql` offers two directives for skipping autogeneration for specified types/fields:
 
-* xref::reference/directives/schema-configuration/type-configuration.adoc#_exclude_deprecated[`@exclude`]: Skip generation of specified Query/Mutation fields for an object type
+* xref::/schema-configuration/type-configuration.adoc#_exclude_deprecated[`@exclude`]: Skip generation of specified Query/Mutation fields for an object type
 * xref::custom-resolvers.adoc#custom-resolver-directive[`@customResolver`]: Ignore a field, which will need custom logic for resolution
 
 ==== `@isAuthenticated`, `@hasRole` and `@hasScope`
@@ -245,7 +245,7 @@ Not supported at this time.
 
 ==== `@id`
 
-There is an equivalent directive in the new library, but it does not work using database constraints as per the old library. See xref::reference/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`].
+There is an equivalent directive in the new library, but it does not work using database constraints as per the old library. See xref::/type-definitions/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`].
 
 ==== `@unique`, `@index` and `@search`
 
@@ -255,7 +255,7 @@ These all relate to database indexes and constraints, which are not currently su
 
 ==== Scalar Types
 
-Supported as you would expect, with additional xref::reference/type-definitions/types.adoc#type-definitions-types-bigint[`BigInt`] support for 64 bit integers.
+Supported as you would expect, with additional xref::/type-definitions/types/scalar.adoc[`BigInt`] support for 64 bit integers.
 
 ==== Temporal Types (`DateTime`, `Date`)
 
@@ -285,14 +285,14 @@ Has become:
 
 Due to the move to ISO 8601 strings, input types are no longer necessary for temporal instances, so `_Neo4jDateTimeInput` has become `DateTime` and `_Neo4jDateInput` has become `Date` for input.
 
-See xref::reference/type-definitions/types.adoc#type-definitions-types-temporal[Temporal Types].
+See xref::/type-definitions/types/temporal.adoc[Temporal Types].
 
 ==== Spatial Types
 
 The single type in `neo4j-graphql-js`, `Point`, has been split out into two types:
 
-* xref::reference/type-definitions/types.adoc#type-definitions-types-point[`Point`]
-* xref::reference/type-definitions/types.adoc#type-definitions-types-cartesian-point[`CartesianPoint`]
+* xref::/type-definitions/types/spatial.adoc#_point[`Point`]
+* xref::/type-definitions/types/spatial.adoc#_cartesianpoint[`CartesianPoint`]
 
 Correspondingly, `_Neo4jPointInput` has also been split out into two input types:
 
@@ -303,11 +303,11 @@ Using them in Queries and Mutations should feel remarkably similar.
 
 ==== Interface Types
 
-Supported, queryable using inline fragments as per `neo4j-graphql-js`, but can also be created using Nested Mutations. See xref::reference/type-definitions/interfaces.adoc[Interfaces].
+Supported, queryable using inline fragments as per `neo4j-graphql-js`, but can also be created using Nested Mutations. See xref::/type-definitions/types/interfaces.adoc[Interfaces].
 
 ==== Union Types
 
-Supported, queryable using inline fragments as per `neo4j-graphql-js`, but can also be created using Nested Mutations. See xref::reference/type-definitions/unions.adoc#type-definitions-unions[Unions].
+Supported, queryable using inline fragments as per `neo4j-graphql-js`, but can also be created using Nested Mutations. See xref::/type-definitions/types/unions.adoc#type-definitions-unions[Unions].
 
 === Fields
 

modules/ROOT/pages/migration/index.adoc

@@ -201,12 +201,12 @@ To improve consistency, some automatically generated plurals (e.g. `createActors
 your types use conventions such as `snake_case`.
 
 Because of this, you may find generated queries and mutations may have different names. If you encounter this problem,
-please update your clients to use the new query names or use the `plural` option in the xref::reference/directives/database-mapping.adoc#type-definitions-node[@node directive]
+please update your clients to use the new query names or use the `plural` option in the xref::/type-definitions/directives/database-mapping.adoc#type-definitions-node[@node directive]
 to force a custom plural value.
 
 == Custom Directives
 Defining and applying custom directives has changed significantly, if you are using or plan to use custom directives, make
-sure to check the up-to-date documentation on xref::reference/directives/custom-directives.adoc[custom directives].
+sure to check the up-to-date documentation on xref::/type-definitions/directives/custom-directives.adoc[custom directives].
 
 == Types changes
 Some automatically generated types have changed to improve consistency.

modules/ROOT/pages/migration/v3-migration.adoc

@@ -992,7 +992,7 @@ const neoSchema = new Neo4jGraphQL({
 === Opt-in Aggregation
 
 Aggregation operations are no longer generated by default.
-They can be enabled case by case using the directives xref::reference/directives/schema-configuration/type-configuration.adoc#_query[`@query`] and xref::reference/directives/schema-configuration/field-configuration.adoc#_relationship[`@relationship`].
+They can be enabled case by case using the directives xref::/schema-configuration/type-configuration.adoc#_query[`@query`] and xref::/schema-configuration/field-configuration.adoc#_relationship[`@relationship`].
 
 You can enable the operation fields `actorsAggregate` and `actedInAggregate` like this:
 

modules/ROOT/pages/migration/v4-migration/index.adoc

@@ -42,7 +42,7 @@ This allows you to create not only the type in question, but to recurse down and
 
 [NOTE]
 ====
-The `id` field is absent from both `create` input types as the xref::reference/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`] directive has been used.
+The `id` field is absent from both `create` input types as the xref::/type-definitions/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`] directive has been used.
 ====
 
 == Single `create`

modules/ROOT/pages/mutations/create.adoc

@@ -53,7 +53,7 @@ type Mutation {
 
 [NOTE]
 ====
-The `id` field cannot be updated as the xref::reference/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`] directive has been used.
+The `id` field cannot be updated as the xref::/type-definitions/directives/autogeneration.adoc#type-definitions-autogeneration-id[`@id`] directive has been used.
 ====
 
 == Single `update`
@@ -412,7 +412,7 @@ mutation {
 == Mathematical operators
 
 Mathematical operators can be used to update numerical fields based on their original values in a single DB transaction.
-For that, specific operators are available on different numerical types: `Int`, `Float`, xref::reference/type-definitions/types.adoc#type-definitions-types-bigint[`BigInt`].
+For that, specific operators are available on different numerical types: `Int`, `Float`, xref::/type-definitions/types/scalar.adoc[`BigInt`].
 They are supported within these entities:
 
 * Nodes

modules/ROOT/pages/mutations/update.adoc

@@ -390,7 +390,7 @@ const users = await User.find({ where: { name: "Jane Smith" }});
 |`options` +
  +
  Type: `GraphQLOptionsArg`
-|A JavaScript object representation of the GraphQL `options` input type used for xref::queries-aggregations/sorting.adoc[Sorting] and xref::pagination/index.adoc[Pagination].
+|A JavaScript object representation of the GraphQL `options` input type used for xref::queries-aggregations/sorting.adoc[Sorting] and xref::/queries-aggregations/pagination/index.adoc[Pagination].
 
 |`selectionSet` +
  +
@@ -467,7 +467,7 @@ const { users } = await User.update({
 |`options` +
  +
  Type: `GraphQLOptionsArg`
-|A JavaScript object representation of the GraphQL `options` input type used for xref::queries-aggregations/sorting.adoc[Sorting] and xref::pagination/index.adoc[Pagination].
+|A JavaScript object representation of the GraphQL `options` input type used for xref::queries-aggregations/sorting.adoc[Sorting] and xref::/queries-aggregations/pagination/index.adoc[Pagination].
 
 |`selectionSet` +
  +