Changes to documentation (#2209)
* refactored Storybook UI * refactored Storybook UI * removed extra cards from the doc, added card for ui components * added hover behavior to doc page & made it look selected * separate storybook docs and tests * separating storybook tests and docs * fixed spelling errors in docs * Final round of edits for frontend, added backend folder architecture * Created CODE_OF_CONDUCT.md * Add code of conduct to contributing.md * doc changes * fixed broken links * doc addition and changes * introduce user guide & graphql api
This commit is contained in:
25
docs/docs/developer/graphql_api.mdx
Normal file
25
docs/docs/developer/graphql_api.mdx
Normal file
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: GraphQL API
|
||||
sidebar_position: 2
|
||||
sidebar_custom_props:
|
||||
icon: TbBrandGraphql
|
||||
---
|
||||
|
||||
Use our [in-browser GraphiQL app](https://docs.twenty.com/graphql/) to browse, query, and mutate our introspection query.
|
||||
|
||||
## What is GraphQL?
|
||||
|
||||
GraphQL is a query language for APIs that enables declarative data fetching that allows a client to specify exactly what data it needs from the API.
|
||||
|
||||
Instead of exposing various endpoints that return fixed data strcutures, GraphQL exposes only a single endpoint that precisely returns the data that the client asked for. This makes GraphQL more flexible and efficient than other kinds of APIs, like REST APIs.
|
||||
|
||||
To learn more about GraphQL, we recommend going through this [Introduction](https://www.howtographql.com/basics/0-introduction/).
|
||||
|
||||
## About GraphQL Introspection
|
||||
|
||||
GraphQL query language is strongly typed, which makes it possible for you to query and understand the underlying schema.
|
||||
|
||||
With the Introspection feature, you can query the schema and discover the queries (to request data), mutations (to modify data), types, and fields available in a particular GraphQL API.
|
||||
|
||||
## Try Our GraphQL Playground
|
||||
Use our browser-based, interactive [GraphQL playground](https://docs.twenty.com/graphql/) to run mutations and queries to discover valid fields and where you can use them.
|
||||
@ -1,10 +0,0 @@
|
||||
---
|
||||
title: Overview
|
||||
sidebar_position: 1
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: TbArticle
|
||||
---
|
||||
|
||||
|
||||
Soon you'll be able to use our REST APIs to extend the app based on your needs.
|
||||
9
docs/docs/developer/rest_api.mdx
Normal file
9
docs/docs/developer/rest_api.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Rest API
|
||||
sidebar_position: 3
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: TbApi
|
||||
---
|
||||
|
||||
Coming soon!
|
||||
4
docs/docs/user-guide/_category_.json
Normal file
4
docs/docs/user-guide/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "User Guide",
|
||||
"position": 3
|
||||
}
|
||||
9
docs/docs/user-guide/custom objects.mdx
Normal file
9
docs/docs/user-guide/custom objects.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Custom Objects
|
||||
sidebar_position: 1
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: TbAugmentedReality
|
||||
---
|
||||
|
||||
Coming soon!
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Glossary
|
||||
sidebar_position: 2
|
||||
sidebar_position: 3
|
||||
sidebar_custom_props:
|
||||
icon: TbVocabulary
|
||||
---
|
||||
11
docs/docs/user-guide/user-guide.mdx
Normal file
11
docs/docs/user-guide/user-guide.mdx
Normal file
@ -0,0 +1,11 @@
|
||||
---
|
||||
title: User Guide
|
||||
displayed_sidebar: userSidebar
|
||||
sidebar_class_name: hidden
|
||||
sidebar_position: 0
|
||||
sidebar_custom_props:
|
||||
icon: TbUsers
|
||||
isSidebarRoot: true
|
||||
---
|
||||
|
||||
Coming soon!
|
||||
9
docs/docs/user-guide/zapier integration.mdx
Normal file
9
docs/docs/user-guide/zapier integration.mdx
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Zapier tutorial
|
||||
sidebar_position: 2
|
||||
sidebar_class_name: coming-soon
|
||||
sidebar_custom_props:
|
||||
icon: TbBrandZapier
|
||||
---
|
||||
|
||||
Coming soon!
|
||||
Reference in New Issue
Block a user