+ );
+ }
+}
+
+Template.contextTypes = {
+ router: React.PropTypes.func
+};
+
+module.exports = Template;
diff --git a/docs/pages/docs/basic-types.md b/docs/pages/docs/basic-types.md
new file mode 100644
index 00000000..7a067942
--- /dev/null
+++ b/docs/pages/docs/basic-types.md
@@ -0,0 +1,52 @@
+---
+title: Basic Types
+description: Walkthrough Basic Types
+---
+
+# Basic Types
+
+Graphene define the following base Types:
+- `graphene.String`
+- `graphene.Int`
+- `graphene.Float`
+- `graphene.Boolean`
+- `graphene.ID`
+
+Also, define:
+- `graphene.List`
+- `graphene.NonNull`
+
+## Mounting in ClassTypes
+
+This types if are mounted in a `ObjectType`, `Interface` or `Mutation`,
+ would act as `Field`s.
+So, the following examples will behave exactly the same:
+
+```python
+class Person(graphene.ObjectType):
+ name = graphene.String()
+```
+and
+
+```python
+class Person(graphene.ObjectType):
+ name = graphene.Field(graphene.String())
+```
+
+## Mounting in Fields
+
+If this types are mounted in a `Field`, would act as `Argument`s.
+So, the following examples will behave exactly the same:
+
+```python
+class Person(graphene.ObjectType):
+ say_hello = graphene.Field(graphene.String(),
+ to=graphene.String())
+```
+and
+
+```python
+class Person(graphene.ObjectType):
+ say_hello = graphene.Field(graphene.String(),
+ to=graphene.Argument(graphene.String()))
+```
diff --git a/docs/pages/guide/interface.md b/docs/pages/docs/interfaces.md
similarity index 76%
rename from docs/pages/guide/interface.md
rename to docs/pages/docs/interfaces.md
index 9f5ff2b9..43c2daf8 100644
--- a/docs/pages/guide/interface.md
+++ b/docs/pages/docs/interfaces.md
@@ -1,9 +1,13 @@
+---
+title: Interfaces
+description: Walkthrough Interfaces
+---
+
# Interfaces
An Interface contains the essential fields that will be shared among multiple ObjectTypes.
The basics:
-
- Each Interface is a Python class that inherits from graphene.Interface.
- Each attribute of the Interface represents a GraphQL field.
@@ -16,19 +20,19 @@ import graphene
# Character is an Interface
class Character(graphene.Interface):
- name = graphene.String()
+ name = graphene.String()
# Human is an ObjectType, as inherits an interface
class Human(Character):
- born_in = graphene.String()
+ born_in = graphene.String()
# Droid is an ObjectType, as inherits an interface
class Droid(Character):
- function = graphene.String()
+ function = graphene.String()
```
-**name** is a field in the `Character` interface that will be in both `Human` and `Droid` ObjectTypes (as those inherit from Character). Each ObjectType also define extra fields at the same time.
+**name** is a field in the `Character` interface that will be in both `Human` and `Droid` ObjectTypes (as those inherit from `Character`). Each ObjectType also define extra fields at the same time.
The above types would have the following representation in a schema:
diff --git a/docs/pages/docs/mutations.md b/docs/pages/docs/mutations.md
new file mode 100644
index 00000000..7967f62c
--- /dev/null
+++ b/docs/pages/docs/mutations.md
@@ -0,0 +1,75 @@
+---
+title: Mutations
+description: Walkthrough Mutations
+---
+
+# Mutations
+
+A Mutation is a special ObjectType that define also an Input.
+
+## Quick example
+
+This example defines a Mutation:
+
+```python
+import graphene
+
+class CreatePerson(graphene.Mutation):
+ class Input:
+ name = graphene.String()
+
+ ok = graphene.String()
+ person = graphene.Field('Person')
+
+ @classmethod
+ def mutate(cls, args, info):
+ person = Person(name=args.get('name'))
+ ok = True
+ return CreatePerson(person=person, ok=ok)
+```
+
+**person** and **ok** are the output fields of the Mutation when is resolved.
+
+**Input** attributes are the arguments that the Mutation `CreatePerson` needs for resolving, in this case **name** will be the only argument for the mutation.
+
+**mutate** is the function that will be applied once the mutation is called.
+
+So, we can finish our schema like this:
+
+```python
+# ... the Mutation Class
+
+class Person(graphene.ObjectType):
+ name = graphene.String()
+
+class MyMutations(graphene.ObjectType):
+ create_person = graphene.Field(CreatePerson)
+
+schema = graphene.Schema(mutation=MyMutations)
+```
+
+## Executing the Mutation
+
+Then, if we query (`schema.execute(query_str)`) the following:
+```graphql
+mutation myFirstMutation {
+ createPerson(name:"Peter") {
+ person {
+ name
+ }
+ ok
+ }
+}
+```
+
+We should receive:
+
+```json
+{
+ "createPerson": {
+ "person" : {
+ name: "Peter"
+ },
+ "ok": true
+ }
+}
diff --git a/docs/pages/guide/objecttype.md b/docs/pages/docs/objecttypes.md
similarity index 85%
rename from docs/pages/guide/objecttype.md
rename to docs/pages/docs/objecttypes.md
index 191094ae..dbcab0f3 100644
--- a/docs/pages/guide/objecttype.md
+++ b/docs/pages/docs/objecttypes.md
@@ -1,10 +1,14 @@
+---
+title: ObjectTypes
+description: Walkthrough ObjectTypes
+---
+
# ObjectTypes
An ObjectType is the single, definitive source of information about your data. It contains the essential fields and behaviors of the data you’re querying.
The basics:
-
-- Each ObjectType is a Python class that inherits graphene.ObjectType or inherits an implemented [interface](/docs/interface).
+- Each ObjectType is a Python class that inherits graphene.ObjectType or inherits an implemented [interfaces](/docs/interfaces/).
- Each attribute of the ObjectType represents a GraphQL field.
## Quick example
@@ -20,7 +24,7 @@ class Person(graphene.ObjectType):
full_name = graphene.String()
def resolve_full_name(self, args, info):
- return '{} {}'.format(self.first_name, self.last_name)
+ return '{} {}'.format(self.first_name, self.last_name)
```
**first_name** and **last_name** are fields of the ObjectType. Each field is specified as a class attribute, and each attribute maps to a GraphQL field.
diff --git a/docs/pages/docs/django_quickstart.md b/docs/pages/docs/quickstart-django.md
similarity index 95%
rename from docs/pages/docs/django_quickstart.md
rename to docs/pages/docs/quickstart-django.md
index e88fbcdf..542854e7 100644
--- a/docs/pages/docs/django_quickstart.md
+++ b/docs/pages/docs/quickstart-django.md
@@ -1,13 +1,10 @@
---
-title: Django Quickstart Guide
-active_tab: quickstart
+title: Guide to Django
description: A Quick guide to Graphene in Django
---
-## Django Quickstart
-
In our previous quickstart page we created a very simple schema.
-Now we will adapt the schema for our Django models.
+Now we will adapt the schema to map automatically some Django models.
## Project setup
diff --git a/docs/pages/docs/quickstart.md b/docs/pages/docs/quickstart.md
index f408a851..f2c56f03 100644
--- a/docs/pages/docs/quickstart.md
+++ b/docs/pages/docs/quickstart.md
@@ -1,10 +1,10 @@
---
-title: Quickstart Guide
-active_tab: quickstart
+title: Getting started
description: A Quick guide to Graphene
---
-Graphene is a powerful framework for creating GraphQL schemas easily in Python.
+Let's build a basic GraphQL schema from scratch.
+
## Requirements
@@ -23,6 +23,7 @@ cd tutorial
virtualenv env
source env/bin/activate # On Windows use `env\Scripts\activate`
+# Install Graphene
pip install graphene
```
@@ -30,7 +31,7 @@ pip install graphene
A GraphQL schema describes your data model, and provides a GraphQL server with an associated set of resolve methods that know how to fetch data.
-We are going to create a very simple schema, with a `Query` with only one field: `hello`. And when we query it should return 'World'.
+We are going to create a very simple schema, with a `Query` with only one field: `hello`. And when we query it should return `"World"`.
```python
diff --git a/docs/pages/guide/mutation.md b/docs/pages/guide/mutation.md
deleted file mode 100644
index 788cadfd..00000000
--- a/docs/pages/guide/mutation.md
+++ /dev/null
@@ -1,67 +0,0 @@
-# Mutations
-
-A Mutation is a special ObjectType that define also an Input.
-
-## Quick example
-
-This example model defines a Mutation:
-
-```python
-import graphene
-
-class CreatePerson(graphene.Mutation):
- class Input:
- name = graphene.String()
-
- ok = graphene.String()
- person = graphene.Field('Person')
-
- @classmethod
- def mutate(cls, args, info):
- person = Person(name=args.get('name'))
- ok = True
- return CreatePerson(person=person, ok=ok)
-```
-
-**person** and **ok** are the output fields of the Mutation when is resolved.
-**Input** attributes are the arguments that the Mutation needs for resolving. **mutate** is the function that will be applied once the mutation is called.
-
-So, we can finish our schema like this:
-
-```python
-# ... the Mutation Class
-
-class Person(graphene.ObjectType):
- name = graphene.String()
-
-class MyMutations(graphene.ObjectType):
- create_person = graphene.Field(CreatePerson)
-
-schema = graphene.Schema(mutation=MyMutations)
-```
-
-## Executing the Mutation
-
-Then, if we query (`schema.execute(query_str)`) the following:
-```graphql
-mutation myFirstMutation {
- createPerson(name:"Peter") {
- person {
- name
- }
- ok
- }
-}
-```
-
-We should receive:
-
-```json
-{
- "createPerson": {
- "person" : {
- name: "Peter"
- },
- "ok": true
- }
-}
diff --git a/docs/pages/index.md b/docs/pages/index.md
index 80444d40..359e512b 100644
--- a/docs/pages/index.md
+++ b/docs/pages/index.md
@@ -1,7 +1,7 @@
---
path: /
---
-