redoc/.github/styles/Rules/HeaderGerunds.yml

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
docs: adds vale rules and workflow for running in CI (#2348) * docs: adds vale rules and workflow for running in CI * docs: updates product name from ReDoc to Redoc 2023-07-11 20:31:52 +03:00			`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:`
			`- '^\wing.'`
Config docs and README refresh (#2393) * 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> 2023-09-21 17:19:27 +03:00			`exceptions:`
			`- expandSingleSchemaField`
			`- hideLoading`
			`- hideSingleRequestSampleTab`