Skip to content

Commit 3822061

Browse files
committed
add navigation information to pages for just-the-docs
1 parent 431c506 commit 3822061

13 files changed

+86
-0
lines changed

docs/getting-started.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Getting Started
4+
nav_order: 2
5+
has_children: false
6+
permalink: /docs/getting-started/
7+
---
18
# Installation
29
To install php-graphql, you basically have two options. You can either use composer or git submodules.
310

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Introduction
4+
nav_order: 1
5+
has_children: false
6+
permalink: /docs/
7+
---
18
# Introduction
29
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
310

docs/parsing-validating-executing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Parsing, Validation, Execution
4+
nav_order: 6
5+
has_children: false
6+
permalink: /docs/parsing-validating-executing/
7+
---
18
# Introduction
29
This section describes how parsing, validation and execution in a high level and should only be interesting for building an own processing pipeline or understanding how the GraphQL-Server works.
310
In all other cases the default `Server` should be fine to use.

docs/schema-definition.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Schema Definition
4+
nav_order: 3
5+
has_children: false
6+
permalink: /docs/schema-definition/
7+
---
18
# Schema Definition
29
The schema is a container for your type hierarchy that accepts object types as roots for the query type, and the mutation type.
310
It is passed to the validator and the executor and used to model your underlying data structures.

docs/server.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Server
4+
nav_order: 5
5+
has_children: false
6+
permalink: /docs/server/
7+
---
18
# Server
29
The default `Server` is a simple wrapper around a parser, validator and executor to save you work.
310
When constructing a server, simply pass the schema to the constructor and enable processing via the `listen()` function.

docs/types/directives.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Directives
4+
parent: Types
5+
nav_order: 7
6+
---
17
# Directives
28
A directive describes how the data should be processed at a meta level.
39
A directive can be attached to a field or fragment and can affect the execution of the query.

docs/types/enums.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
layout: default
3+
title: Enums
4+
parent: Types
5+
nav_order: 3
6+
---
7+
18
# Enums
29
Enumeration types are a special kind of scalar that is restricted to a particular set of allowed values and in this implementation handled as string values.
310

docs/types/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
layout: default
3+
title: Types
4+
nav_order: 4
5+
has_children: true
6+
permalink: /docs/types/
7+
---
8+
19
# Types
210
In **php-graphql**, types are represented as instances of a GraphQL-Type-Class. Supported built in types are:
311
- ```GraphQLBoolean()```

docs/types/interfaces.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Interfaces
4+
parent: Types
5+
nav_order: 5
6+
---
17
# Interfaces
28
An Interface is an abstract type that includes a certain set of fields that a type must include to implement the interface.
39
An Interface can never be returned directly but must be implemented by 'child types'.

docs/types/list-and-non-nulls.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: default
3+
title: Lists and Non-Nulls
4+
parent: Types
5+
nav_order: 4
6+
---
17
# Lists and Non-Nulls
28
Lists and Non-Nulls are wrapping types in GraphQL. This means, that they cannot be used solely, but must feature an inner type, which they hold.
39

0 commit comments

Comments
 (0)