mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-24 09:33:44 +03:00
b3503f2109
* docs: Give Redoc a landing page with overview and tldr instructions * docs: move config to dedicated page * docs: modernise README, link to resources * docs: more detailed format for theme configurations * fix: README formatting * fix: Fix future tense errors and add exceptions for config fields as headings * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> * docs: minor updates from excellent pull request feedback * docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page * Apply suggestions from code review Co-authored-by: Heather Cloward <heathercloward@gmail.com> --------- Co-authored-by: Heather Cloward <heathercloward@gmail.com>
12 lines
347 B
YAML
12 lines
347 B
YAML
extends: existence
|
|
message: 'Do not start headings with with a gerund (ing word). Use an imperative verb instead.'
|
|
link: https://intranet.redoc.ly/contributing/documentation-style-guide/#content-organization
|
|
level: error
|
|
scope: heading
|
|
tokens:
|
|
- '^\w*ing.*'
|
|
exceptions:
|
|
- expandSingleSchemaField
|
|
- hideLoading
|
|
- hideSingleRequestSampleTab
|