mirror of
https://github.com/supabase/supabase.git
synced 2026-10-10 03:45:06 +03:00
Miranda LimonczenkoandMiranda Limonczenko
dcf02db5c7
Closes [DOCS-1036](https://linear.app/supabase/issue/DOCS-1036/add-docs-lint-rule-for-copywriting-style-gaps) ## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? This change expands upon the "us this, not that" style rules and applies them to our linting. ## What is the current behavior? Our current behavior does far fewer checks. ## What is the new behavior? The new behavior spots the following: - Suggesting swapping Latin phrases for common English - Remove formal words for simpler words - Removes marketing language - And more (see code diff) ## Additional context For more information about general style rules, see the style guide: https://supabase.com/design-system/docs/copywriting <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Refined contribution guidelines with clearer style guidance for filler words, terminology (including “Backend” hyphenation), abbreviation usage, and updated wording examples. * Updated the foundations quickstart wording to “Utilize shadcn/ui” under setup guidance. * **Chores** * Expanded MDX linting guidance to flag filler/marketing language, vague verbs, formal corporate phrasing, apologies, human-language punctuation variants, and certain Latin phrases. * Adjusted related lint preferences and downgraded several checks to **WARNING** for a less disruptive experience. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Miranda Limonczenko <miranda@supabase.io>
30 lines
1.5 KiB
TOML
30 lines
1.5 KiB
TOML
ignore_patterns = ["**/_*.mdx"]
|
|
|
|
# Heading should be sentence case
|
|
Rule001HeadingCase = "include('supa-mdx-lint/Rule001HeadingCase.toml')"
|
|
|
|
# Check spelling
|
|
# Error message: "Word not found in dictionary"
|
|
Rule003Spelling = "include('supa-mdx-lint/Rule003Spelling.toml')"
|
|
|
|
[Rule002AdmonitionTypes]
|
|
# Allowed admonition types are:
|
|
admonition_types = ["note", "tip", "caution", "deprecation", "danger"]
|
|
|
|
[Rule004ExcludeWords]
|
|
rules.filler = "include('supa-mdx-lint/Rule004ExcludeWords/filler.toml')"
|
|
rules.marketing = "include('supa-mdx-lint/Rule004ExcludeWords/marketing.toml')"
|
|
rules.vague_verbs = "include('supa-mdx-lint/Rule004ExcludeWords/vague_verbs.toml')"
|
|
rules.generic_phrases_apology = "include('supa-mdx-lint/Rule004ExcludeWords/generic_phrases_apology.toml')"
|
|
rules.first_person = "include('supa-mdx-lint/Rule004ExcludeWords/first_person.toml')"
|
|
rules.gender_neutral = "include('supa-mdx-lint/Rule004ExcludeWords/gender_neutral.toml')"
|
|
rules.inclusive_wording = "include('supa-mdx-lint/Rule004ExcludeWords/inclusive_wording.toml')"
|
|
rules.human_language = "include('supa-mdx-lint/Rule004ExcludeWords/human_language.toml')"
|
|
rules.latin_phrases = "include('supa-mdx-lint/Rule004ExcludeWords/latin_phrases.toml')"
|
|
rules.preferred_usage = "include('supa-mdx-lint/Rule004ExcludeWords/preferred_usage.toml')"
|
|
rules.formal_corporate = "include('supa-mdx-lint/Rule004ExcludeWords/formal_corporate.toml')"
|
|
rules.slang = "include('supa-mdx-lint/Rule004ExcludeWords/slang.toml')"
|
|
|
|
[Rule006NoAbsoluteUrls]
|
|
base_url = "https://supabase.com"
|