Add docs

.github/workflows/book.yml

@@ -0,0 +1,55 @@
+name: Book
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+
+jobs:
+  deploy_en:
+    name: Deploy book on gh-pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install mdBook
+        uses: peaceiris/actions-mdbook@v1
+      - name: Render book
+        run: |
+          mdbook build -d gh-pages docs/en
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v2.5.1
+        with:
+          emptyCommits: false
+          keepFiles: true
+        env:
+          ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          PUBLISH_BRANCH: gh-pages-en
+          PUBLISH_DIR: docs/book/gh-pages
+  deploy_zh_CN:
+    name: Deploy book on gh-pages
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install mdBook
+        uses: peaceiris/actions-mdbook@v1
+      - name: Render book
+        run: |
+          mdbook build -d gh-pages-zh-CN docs/zh-CN
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v2.5.1
+        with:
+          emptyCommits: false
+          keepFiles: true
+        env:
+          ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          PUBLISH_BRANCH: gh-pages-zh-CN
+          PUBLISH_DIR: docs/book/gh-pages

.github/workflows/ci.yml

@@ -4,7 +4,9 @@ on:
   push:
     branches:
       - master
-  pull_request: {}
+  pull_request:
+    branches:
+      - master
 
 jobs:
   build:
@@ -20,6 +22,7 @@ jobs:
       - name: Run tests
         run: cargo test --all --verbose
   cover:
+    needs: [build]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1

.gitignore

@@ -2,4 +2,4 @@
 Cargo.lock
 .idea
 .DS_Store
-node_modules
+node_modules

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/en/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["sunli"]
+description = "Async-graphql Book"
+src = "src"
+language = "zh-CN"
+title = "Async-graphql Book"

docs/en/src/SUMMARY.md

@@ -0,0 +1,31 @@
+# Async-graphql Book
+
+- [Introduction](introduction.md)
+- [Quickstart](quickstart.md)
+- [Type System](typesystem.md)
+    - [SimpleObject](define_simple_object)
+    - [Object](define_complex_object)
+        - [Context](context)
+        - [Error handling](error_handling)
+    - [Enum](define_enum)
+    - [Interface](define_interface)
+    - [Union](define_union)
+    - [InputObject](define_input_object)
+- [Schema](define_schema)
+    - [Query and Mutation](query_and_mutation)
+    - [Subscription](subscription)
+- [Utilities](utilities)
+    - [Input value validators](input_value_validators)
+    - [Cache control](cache_control)
+    - [Cursor connections](cursor_connections)
+    - [Error extensions](error_extensions)
+    - [Apollo Tracing](apollo_tracing)
+- [Integrations](integrations)
+    - [Warp](integrations_to_warp)
+    - [Actix-web](integrations_to_actix_web)
+- [Advanced topics](advanced_topics)
+    - [Custom scalars](custom_scalars)
+    - [Custom input value validators](custom_input_value_validators)
+    - [Custom extensions](custom_extensions)
+    - [Custom subscription transport](custom_subscription_transport)
+    - [Apollo Federation](apollo_federation)

docs/en/src/advanced_topics

@@ -0,0 +1 @@
+# Advanced topics

docs/en/src/apollo_federation

@@ -0,0 +1 @@
+# Apollo Federation

docs/en/src/apollo_tracing

@@ -0,0 +1 @@
+# Apollo Tracing

docs/en/src/cache_control

@@ -0,0 +1 @@
+# Cache control

docs/en/src/context

@@ -0,0 +1 @@
+# Context

docs/en/src/cursor_connections

@@ -0,0 +1 @@
+# Cursor

docs/en/src/custom_extensions

@@ -0,0 +1 @@
+# Custom extensions

docs/en/src/custom_input_value_validators

@@ -0,0 +1 @@
+# Custom input value validators

docs/en/src/custom_scalars

@@ -0,0 +1 @@
+# Custom scalars

docs/en/src/custom_subscription_transport

@@ -0,0 +1 @@
+# Custom subscription transport

docs/en/src/define_complex_object

@@ -0,0 +1 @@
+# Object

docs/en/src/define_enum

@@ -0,0 +1 @@
+# Enum

docs/en/src/define_input_object

@@ -0,0 +1 @@
+# InputObject

docs/en/src/define_interface

@@ -0,0 +1 @@
+# Interface

docs/en/src/define_schema

@@ -0,0 +1 @@
+# Schema

docs/en/src/define_simple_object

@@ -0,0 +1 @@
+# SimpleObject

docs/en/src/define_union

@@ -0,0 +1 @@
+# Union

docs/en/src/error_extensions

@@ -0,0 +1 @@
+# Error extensions

docs/en/src/error_handling

@@ -0,0 +1 @@
+# Error handling

docs/en/src/input_value_validators

@@ -0,0 +1 @@
+# Input value validators

docs/en/src/integrations

@@ -0,0 +1 @@
+# Integrations

docs/en/src/integrations_to_actix_web

@@ -0,0 +1 @@
+# Actix-web

docs/en/src/integrations_to_warp

@@ -0,0 +1 @@
+# Warp

docs/en/src/introduction.md

@@ -0,0 +1 @@
+# Introduction

docs/en/src/query_and_mutation

@@ -0,0 +1 @@
+# Query and Mutation

docs/en/src/quickstart.md

@@ -0,0 +1 @@
+# Quickstart

docs/en/src/subscription

@@ -0,0 +1 @@
+# Subscription

docs/en/src/typesystem.md

@@ -0,0 +1 @@
+# Type System

docs/en/src/utilities

@@ -0,0 +1 @@
+# Utilities

docs/zh-CN/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["sunli"]
+description = "Async-graphql使用手册"
+src = "src"
+language = "zh-CN"
+title = "Async-graphql教程"

docs/zh-CN/src/SUMMARY.md

@@ -0,0 +1,30 @@
+# Async-graphql教程
+
+- [介绍](introduction.md)
+- [快速开始](quickstart.md)
+- [类型系统](typesystem.md)
+    - [简单对象(SimpleObject)](define_simple_object)
+    - [对象(Object)](define_complex_object)
+        - [查询上下文(Context)](context)
+        - [错误处理](error_handling)
+    - [枚举(Enum)](define_enum)
+    - [接口(Interface)](define_interface)
+    - [联合(Union)](define_union)
+    - [输入对象(InputObject)](define_input_object)
+- [定义模式(Schema)](define_schema)
+    - [查询和变更](query_and_mutation)
+    - [订阅](subscription)
+- [实用功能](utilities)
+    - [输入值校验器](input_value_validators)
+    - [查询缓存控制](cache_control)
+    - [游标连接(Cursor Connections)](cursor_connections)
+    - [Apollo Tracing支持](apollo_tracing)
+- [集成到WebServer](integrations)
+    - [Warp](integrations_to_warp)
+    - [Actix-web](integrations_to_actix_web)
+- [高级主题](advanced_topics)
+    - [自定义标量](custom_scalars)
+    - [自定义输入值校验器](custom_input_value_validators)
+    - [自定义扩展](custom_extensions)
+    - [自定义订阅传输协议](custom_subscription_transport)
+    - [Apollo Federation集成](apollo_federation)

docs/zh-CN/src/advanced_topics

@@ -0,0 +1 @@
+# 高级主题

docs/zh-CN/src/apollo_federation

@@ -0,0 +1 @@
+# Apollo Federation集成

docs/zh-CN/src/apollo_tracing

@@ -0,0 +1 @@
+# Apollo Tracing支持

docs/zh-CN/src/cache_control

@@ -0,0 +1 @@
+# 查询缓存控制

docs/zh-CN/src/context

@@ -0,0 +1 @@
+# 查询上下文(Context)

docs/zh-CN/src/cursor_connections

@@ -0,0 +1 @@
+# 游标连接(Cursor Connections)

docs/zh-CN/src/custom_extensions

@@ -0,0 +1 @@
+# 自定义扩展

docs/zh-CN/src/custom_input_value_validators

@@ -0,0 +1 @@
+# 自定义输入值校验器

docs/zh-CN/src/custom_scalars

@@ -0,0 +1 @@
+# 自定义标量

docs/zh-CN/src/custom_subscription_transport

@@ -0,0 +1 @@
+# 自定义订阅传输协议

docs/zh-CN/src/define_complex_object

@@ -0,0 +1 @@
+# 对象

docs/zh-CN/src/define_enum

@@ -0,0 +1 @@
+# 枚举(Enum)

docs/zh-CN/src/define_input_object

@@ -0,0 +1 @@
+# 输入对象(InputObject)

docs/zh-CN/src/define_interface

@@ -0,0 +1 @@
+# 接口(Interface)

docs/zh-CN/src/define_object

@@ -0,0 +1 @@
+# 对象

docs/zh-CN/src/define_schema

@@ -0,0 +1 @@
+# 定义模式(Schema)

docs/zh-CN/src/define_simple_object

@@ -0,0 +1 @@
+# 简单对象

docs/zh-CN/src/define_union

@@ -0,0 +1 @@
+# 联合(Union)

docs/zh-CN/src/error_extensions

@@ -0,0 +1 @@
+# 错误扩展

docs/zh-CN/src/error_handling

@@ -0,0 +1 @@
+# 错误处理

docs/zh-CN/src/input_value_validators

@@ -0,0 +1 @@
+# 输入值校验器

docs/zh-CN/src/integrations

@@ -0,0 +1 @@
+# 集成到WebServer

docs/zh-CN/src/integrations_to_actix_web

@@ -0,0 +1 @@
+# Actix-web

docs/zh-CN/src/integrations_to_warp

@@ -0,0 +1 @@
+# Warp

docs/zh-CN/src/introduction.md

@@ -0,0 +1 @@
+# 介绍

docs/zh-CN/src/query_and_mutation

@@ -0,0 +1 @@
+# 查询和变更

docs/zh-CN/src/subscription

@@ -0,0 +1 @@
+# 订阅

docs/zh-CN/src/utilities

@@ -0,0 +1 @@
+# 实用功能