Skip to content

Commit

Permalink
Update STYLE_GUIDE.md (keystonejs#5579)
Browse files Browse the repository at this point in the history
  • Loading branch information
bladey authored Apr 30, 2021
1 parent 72c930b commit c8223cc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Documentation Style

# Documentation Style

This document describes the conventions for formatting and style used throughout Keystone 5 docs.
This document describes the conventions for formatting and style used throughout Keystone Next docs.

Many of these rules are enforced by the Prettier Markdown parser,
[Remark](https://github.com/remarkjs/remark/tree/master/packages/remark-parse),
Expand Down Expand Up @@ -109,7 +109,7 @@ replacing spaces with hyphens and prefixing with a hash, eg: the [Text Blocks se
It's important to remember that the Markdown files within this project are used in several places:

- As raw Markdown in a local dev environment (eg. in editor, search/grep'ing, etc.)
- Published on the [Keystone website](https://keystonejs.com/)
- Published on the [Keystone Next website](https://next.keystonejs.com/)
- Published on the [GitHub repo](https://github.com/keystonejs/keystone)
- Published on NPM (only effects package `README.md` docs)

Expand All @@ -119,12 +119,12 @@ For links to work across these mediums, certain rules for URLs formulation must
- Eg. `See the secion on [Foo Config](#foo-config).`
- Links to _other files in the monorepo_ must use..
- An absolute file path from the monorepo root
- Eg. `/docs/api/hooks.md` (**not** `https://www.keystonejs.com/guides/hooks` or `https://github.com/keystonejs/keystone/blob/master/docs/guides/hooks.md`, etc.)
- Eg. `/docs/pages/guides/cli.mdx` (**not** `https://next.keystonejs.com/guides/cli` or `https://github.com/keystonejs/keystone/blob/master/docs/pages/guides/cli.mdx`, etc.)
- The full filename, include the extension
- Eg. `/docs/guides/access-control.md` (**not** `/docs/guides/access-control`)
- Eg. `/docs/pages/guides/cli.mdx` (**not** `/docs/guides/cli`)
- Links to `README.md` files must be explicit; they cannot rely on the GitHub behaviour that uses `README.md` at a sort of "index" for a directory
- Eg. `/packages/auth-password/README.md#identity` (**not** `/packages/auth-password#identity`)
- Links to directories end in a slash (eg. `/packages/keystone/`)
- Eg. `/packages-next/keystone/README.md#CLI` (**not** `/packages-next/keystone#CLI`)
- Links to directories end in a slash (eg. `/packages-next/keystone/`)
- This as is convention for URLs (so as not to be confused with a files)

## Code and Code Blocks
Expand Down

0 comments on commit c8223cc

Please sign in to comment.