Skip to content

Commit

Permalink
Add descriptions and and keywords to docs
Browse files Browse the repository at this point in the history
Reviewed By: josephsavona

Differential Revision: D27213756

fbshipit-source-id: 7153f7f4a3ffd28acffc3d980e7c3f64e66f83c3
  • Loading branch information
rbalicki2 authored and facebook-github-bot committed Mar 30, 2021
1 parent 392f7f0 commit 6ff9413
Show file tree
Hide file tree
Showing 78 changed files with 371 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: entrypoint-container
title: EntryPointContainer
slug: /api-reference/entrypoint-container/
description: API reference for EntryPointContainer, a React component used to render the root component of an entrypoint
keywords:
- entrypoint
- container
- root
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/api-reference/entrypoint-apis/load-entrypoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: load-entrypoint
title: loadEntryPoint
slug: /api-reference/load-entrypoint/
description: API reference for loadEntryPoint, which imperatively loads an entrypoint and data for its queries
keywords:
- entrypoint
- preload
- render-as-you-fetch
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: use-entrypoint-loader
title: useEntryPointLoader
slug: /api-reference/use-entrypoint-loader/
description: API reference for useEntryPointLoader, a React hook used to load entrypoints in response to user events
keywords:
- render-as-you-fetch
- entrypoint
- preload
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
9 changes: 9 additions & 0 deletions website/docs/api-reference/graphql/graphql-directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
id: graphql-directives
title: GraphQL Directives
slug: /api-reference/graphql-and-directives/
description: API Reference for GraphQL directives
keywords:
- GraphQL
- Directive
- arguments
- argumentDefinitions
- connection
- relay
- inline
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
8 changes: 8 additions & 0 deletions website/docs/api-reference/hooks/load-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@
id: load-query
title: loadQuery
slug: /api-reference/load-query/
description: API reference for loadQuery, which imperatively fetches data for a query, retains that query and returns a query reference
keywords:
- preload
- fetch
- query
- render-as-you-fetch
- retain
- query reference
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: relay-environment-provider
title: RelayEnvironmentProvider
slug: /api-reference/relay-environment-provider/
description: API reference for RelayEnvironmentProvider, which sets a Relay environment in React context
keywords:
- environment
- context
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/api-reference/hooks/use-fragment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: use-fragment
title: useFragment
slug: /api-reference/use-fragment/
description: API reference for useFragment, a React hook used to read fragment data from the Relay store using a fragment reference
keywords:
- fragment
- read
- fragment reference
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/api-reference/hooks/use-lazy-load-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: use-lazy-load-query
title: useLazyLoadQuery
slug: /api-reference/use-lazy-load-query/
description: API reference for useLazyLoadQuery, a React hook used to lazily fetch query data when a component renders
keywords:
- lazy fetching
- query
- fetch
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
3 changes: 3 additions & 0 deletions website/docs/api-reference/hooks/use-mutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: use-mutation
title: useMutation
slug: /api-reference/use-mutation/
description: API reference for useMutation, a React hook used to execute a GraphQL mutation
keywords:
- mutation
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/api-reference/hooks/use-pagination-fragment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: use-pagination-fragment
title: usePaginationFragment
slug: /api-reference/use-pagination-fragment/
description: API reference for usePaginationFragment, a React hook used to paginate a connection
keywords:
- pagination
- connection
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/api-reference/hooks/use-preloaded-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: use-preloaded-query
title: usePreloadedQuery
slug: /api-reference/use-preloaded-query/
description: API reference for usePreloadedQuery, a React hook used to read query data from the Relay store using a query reference
keywords:
- read
- query
- query reference
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
6 changes: 6 additions & 0 deletions website/docs/api-reference/hooks/use-query-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
id: use-query-loader
title: useQueryLoader
slug: /api-reference/use-query-loader/
description: API reference for useQueryLoader, a React hook used to imperatively fetch data for a query in response to a user event
keywords:
- query
- fetch
- preload
- render-as-you-fetch
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/api-reference/hooks/use-refetchable-fragment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: use-refetchable-fragment
title: useRefetchableFragment
slug: /api-reference/use-refetchable-fragment/
description: API reference for useRefetchableFragment, a React hook used to refetch fragment data
keywords:
- refetch
- fragment
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/api-reference/hooks/use-relay-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: use-relay-environment
title: useRelayEnvironment
slug: /api-reference/use-relay-environment/
description: API reference for useRelayEnvironment, a React hook used to access the Relay environment from context
keywords:
- environment
- context
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
3 changes: 3 additions & 0 deletions website/docs/api-reference/hooks/use-subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: use-subscription
title: useSubscription
slug: /api-reference/use-subscription/
description: API reference for useSubscription, a React hook used to subscribe and unsubscribe from a subscription
keywords:
- subscription
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/api-reference/legacy-apis/legacy-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: legacy-apis
title: Legacy APIs
slug: /api-reference/legacy-apis/
description: API reference for legacy APIs
keywords:
- QueryRenderer
- Container
---

API references for our previous legacy APIs are available in our previous docs website:
Expand Down
3 changes: 3 additions & 0 deletions website/docs/api-reference/relay-runtime/commit-mutation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: commit-mutation
title: commitMutation
slug: /api-reference/commit-mutation/
description: API reference for commitMutation, which imperatively executes a mutation
keywords:
- mutation
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/api-reference/relay-runtime/fetch-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: fetch-query
title: fetchQuery
slug: /api-reference/fetch-query/
description: API reference for fetchQuery, which imperatively fetches data for a query and returns an observable
keywords:
- observable
- query
- fetch
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: request-subscription
title: requestSubscription
slug: /api-reference/request-subscription/
description: API reference for requestSubscription, which imperatively establishes a GraphQL subscription
keywords:
- subscription
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 4 additions & 1 deletion website/docs/api-reference/relay-runtime/store.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
id: store
title: RelayModernStore
title: Store
slug: /api-reference/store/
description: API reference for the Relay store
keywords:
- store
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
11 changes: 11 additions & 0 deletions website/docs/debugging/declarative-mutation-directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@
id: declarative-mutation-directives
title: Debugging Declarative Mutation Directives
slug: /debugging/declarative-mutation-directives/
description: Debugging declarative mutation directives
keywords:
- debugging
- troubleshooting
- declarative mutation directive
- deleteRecord
- handlerProvider
- appendEdge
- prependEdge
- appendNode
- prependNode
---

import FbEnvHandlerExample from './fb/FbEnvHandlerExample.md';
Expand Down
7 changes: 7 additions & 0 deletions website/docs/debugging/inconsistent-typename-error.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
id: inconsistent-typename-error
title: Inconsistent Typename Error
slug: /debugging/inconsistent-typename-error/
description: Debugging inconsistent typename errors in Relay
keywords:
- debugging
- troubleshooting
- inconsistent typename
- RelayResponseNormalizer
- globally unique id
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
7 changes: 7 additions & 0 deletions website/docs/debugging/relay-devtools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
id: relay-devtools
title: Relay DevTools
slug: /debugging/relay-devtools/
description: Debugging guide for the Relay DevTools
keywords:
- debugging
- troubleshooting
- extension
- devtools
- browser
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
6 changes: 6 additions & 0 deletions website/docs/getting-started/installation-and-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
id: installation-and-setup
title: Installation and Setup
slug: /getting-started/installation-and-setup/
description: Relay installation and setup guide
keywords:
- installation
- setup
- compiler
- babel-plugin-relay
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
6 changes: 6 additions & 0 deletions website/docs/getting-started/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
id: introduction
title: Introduction to Relay
slug: /
description: Introduction to Relay documentation
keywords:
- relay
- graphql
- data
- introduction
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
3 changes: 3 additions & 0 deletions website/docs/getting-started/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: prerequisites
title: Prerequisites
slug: /getting-started/prerequisites/
description: Prerequisites for setting up Relay
keywords:
- prerequisites
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
3 changes: 3 additions & 0 deletions website/docs/getting-started/step-by-step-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: step-by-step-guide
title: Step-by-step Guide
slug: /getting-started/step-by-step-guide/
description: Step-by-step guide for setting up Relay
keywords:
- setup
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
3 changes: 3 additions & 0 deletions website/docs/glossary/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: glossary
title: Glossary
slug: /glossary/
description: Relay terms glossary
keywords:
- glossary
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
6 changes: 6 additions & 0 deletions website/docs/guided-tour/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
id: introduction
title: Introduction
slug: /guided-tour/
description: Relay guided tour
keywords:
- guided tour
- relay
- graphql
- documentation
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
5 changes: 5 additions & 0 deletions website/docs/guided-tour/list-data/advanced-pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@
id: advanced-pagination
title: Advanced Pagination
slug: /guided-tour/list-data/advanced-pagination/
description: Relay guide for advanced pagination
keywords:
- pagination
- usePaginationFragment
- prefetching
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/guided-tour/list-data/connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: connections
title: Connections
slug: /guided-tour/list-data/connections/
description: Relay guide for connections
keywords:
- pagination
- connections
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
4 changes: 4 additions & 0 deletions website/docs/guided-tour/list-data/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
id: pagination
title: Pagination
slug: /guided-tour/list-data/pagination/
description: Relay guide to pagination
keywords:
- pagination
- usePaginationFragment
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
6 changes: 6 additions & 0 deletions website/docs/guided-tour/list-data/refetching-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
id: refetching-connections
title: Refetching Connections (Using and Changing Filters)
slug: /guided-tour/list-data/refetching-connections/
description: Relay guide to refetching connections
keywords:
- pagination
- refetching
- connection
- useRefetchableFragment
---

import DocsRating from '@site/src/core/DocsRating';
Expand Down
Loading

0 comments on commit 6ff9413

Please sign in to comment.