hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-11-10 00:17:11 +03:00
Code Issues Projects Releases Wiki Activity

docs: add bullet point on infinitive verb form in headings to docs wiki

Browse Source 
## Description

This PR adds a bullet point on using the infinitive verb form in docs headings to the docs wiki.

## Quick link

[/docs/wiki/style/headings](https://marion-docs-update-wiki-to-u.hasura-docs-mono.pages.dev/docs/wiki/style/headings/)

PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7397
GitOrigin-RevId: 88b38d6c771f8e9fc7a70189cea15e6c9caf9f57
This commit is contained in:
Marion Schleifer 2022-12-27 15:48:08 +01:00 committed by hasura-bot
parent 9a3488920f
commit 7dffbc6a0d
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/wiki/style/headings.mdx
View File

@ -16,6 +16,7 @@ slug: headings
- Subheadings which are numbered steps should have the first word after the colon capitalized like this: `Step 0: Do something great`.
- Headings should not end with a period.
- Leave a blank line above and below headings.
- Use the infinitive verb form in all types of headings (correct: "Try out Hasura permissions", wrong: "Trying out Hasura permissions").
- Add an introduction section as `## Introduction` with a short overview of what the page is about.
- Page titles should be self-sufficient. Users might not have the context of the hierarchy of the page in the docs tree.
A user can land on a page via search as well. e.g. Say you are adding a new deployment guide for AWS under