Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

address greptile

Adrian Kahalib21871b3d957
diff --git a/.agents/skills/docs-style/SKILL.md b/.agents/skills/docs-style/SKILL.md
index 485c34ace1..c220092369 100644
--- a/.agents/skills/docs-style/SKILL.md
+++ b/.agents/skills/docs-style/SKILL.md
@@ -44,10 +44,11 @@ Review your own drafts the same way you review anyone else's. Work in the follow
Check the structure first, because rewriting a sentence is wasted work if the sentence is in
the wrong section.
-**1. Run the linter.** Run `make lint-docs-branch` from the repository root. The command exits
-with an error only for error-level problems, so also read the warnings and suggestions it
-prints. `Infisical.UIActions` and `Infisical.Contractions` don't affect the exit code yet, and
-those two rules are the ones most likely to report problems.
+**1. Run the linter.** Run `make lint-docs-branch` from the repository root. Every rule except
+`Infisical.EmDashes` reports at error level, so any other finding fails the command, including
+`Infisical.UIActions` and `Infisical.Contractions`, the two rules most likely to report problems.
+`Infisical.EmDashes` reports at warning level and doesn't change the exit code, so also read the
+warnings the command prints.
Vale doesn't check text indented four or more spaces inside a Mintlify component, and about
half of the text in this repository is indented that way. If Vale reports no problems on a
diff --git a/AGENTS.md b/AGENTS.md
index 62e035d288..6c1be655f4 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -20,7 +20,7 @@ If the user wrote or edited the docs prose themselves, don't just accept it. Tel
The style guide covers writing for users (not implementers), Mintlify component usage, cross-referencing, page structure, the sentence-level writing rules in section 5, and the bolding and UI conventions in section 11.
-Run `make lint-docs-branch` after any change under `docs/` (or `make lint-docs` for the whole site; the `Check docs style` CI check runs the branch variant). It runs [Vale](https://vale.sh) over the docs and enforces the mechanical half of the style guide. A clean run is not a substitute for reading the guide: the judgment calls it cannot check are the ones that matter most. Vale cannot see prose indented inside Mintlify components, so a clean run is not evidence that nested content was checked, and two rules report below error level so they never change the exit code.
+Run `make lint-docs-branch` after any change under `docs/` (or `make lint-docs` for the whole site; the `Check docs style` CI check runs the branch variant). It runs [Vale](https://vale.sh) over the docs and enforces the mechanical half of the style guide. A clean run is not a substitute for reading the guide: the judgment calls it cannot check are the ones that matter most. Vale cannot see prose indented inside Mintlify components, so a clean run is not evidence that nested content was checked, and `Infisical.EmDashes` reports at warning level, so its findings never change the exit code.
## UI Development
diff --git a/CLAUDE.md b/CLAUDE.md
index 3166fdac9b..c6068a85e0 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -96,7 +96,7 @@ If the user wrote or edited the docs prose themselves, don't just accept it. Tel
The style guide covers writing for users (not implementers), Mintlify component usage, cross-referencing, page structure, the sentence-level writing rules in section 5, and the bolding and UI conventions in section 11.
-Run `make lint-docs-branch` after any change under `docs/`. It runs [Vale](https://vale.sh) over the docs and enforces the mechanical half of the style guide: sentence case in headings and frontmatter titles, product and vendor spellings, spelling against a curated vocabulary, `$` prompts in code blocks, and em dash density. See [docs/CONTRIBUTING.MD](docs/CONTRIBUTING.MD) for how to extend the vocabulary or suppress a rule. It lints only the `.mdx` files the branch touched; `make lint-docs` checks every page. The `Check docs style` GitHub workflow runs that same script, so local and CI agree by construction. `Infisical.UIActions` (click/tap where the verb should be select) and `Infisical.Contractions` report at warning and suggestion level, so they never change the exit code -- read the printed output, not just the status. Note that Vale cannot see prose indented four or more spaces inside components -- roughly half of this repo -- and reports nothing about what it skipped, so a clean run does not mean a nested page was checked.
+Run `make lint-docs-branch` after any change under `docs/`. It runs [Vale](https://vale.sh) over the docs and enforces the mechanical half of the style guide: sentence case in headings and frontmatter titles, product and vendor spellings, spelling against a curated vocabulary, `$` prompts in code blocks, and em dash density. See [docs/CONTRIBUTING.MD](docs/CONTRIBUTING.MD) for how to extend the vocabulary or suppress a rule. It lints only the `.mdx` files the branch touched; `make lint-docs` checks every page. The `Check docs style` GitHub workflow runs that same script, so local and CI agree by construction. Every rule except `Infisical.EmDashes` reports at error level, including `Infisical.UIActions` (click/tap where the verb should be select) and `Infisical.Contractions`, so any of their findings fails the run. `Infisical.EmDashes` reports at warning level and never changes the exit code -- read the printed output, not just the status. Note that Vale cannot see prose indented four or more spaces inside components -- roughly half of this repo -- and reports nothing about what it skipped, so a clean run does not mean a nested page was checked.
### Auth & Permissions
diff --git a/docs/CONTRIBUTING.MD b/docs/CONTRIBUTING.MD
index d7d509d19a..55858854e5 100644
--- a/docs/CONTRIBUTING.MD
+++ b/docs/CONTRIBUTING.MD
@@ -71,16 +71,12 @@ fields, the enforced spellings in
placeholders like `foo`, em dashes piling up in one paragraph, "click" and "tap" where the
verb should be "select", and the full forms of common contractions.
-**`Infisical.UIActions` and `Infisical.Contractions` do not fail the run yet.** They report at
-warning and suggestion level, because the existing pages carry 561 and 1,229 of them
-respectively and a blocking rule would fail every pull request that touches one. The target is
-error level for both, by this route:
-
-1. The rules land non-blocking, so the count only goes down as people touch pages.
-2. A dedicated pull request per rule sweeps the corpus. Neither sweep is safe to apply
- mechanically. "Click" as a noun and the deliberately formal phrasing in some reference
- tables both need a person, so this is a reviewed pass, not `vale --fix`.
-3. Flip `level:` to `error` in the rule file once the count is zero.
+**Every rule except `Infisical.EmDashes` is at error level**, including `Infisical.UIActions`
+and `Infisical.Contractions`, so a finding from either one fails the run. `Infisical.EmDashes`
+reports at warning level: it is printed but does not change the exit code. Neither
+`Infisical.UIActions` nor `Infisical.Contractions` is safe to fix with `vale --fix`. "Click" as a
+noun and the deliberately formal phrasing in some reference tables both need a person, so fix
+their findings by hand or turn the rule off for that line.
Nothing checks the two bolding rules in section 11 of the style guide, and nothing will.
Whether a noun is a button that should be bold needs someone who knows the product.
diff --git a/docs/STYLE_GUIDE.md b/docs/STYLE_GUIDE.md
index e171f2349b..0897821b62 100644
--- a/docs/STYLE_GUIDE.md
+++ b/docs/STYLE_GUIDE.md
@@ -428,7 +428,7 @@ Write "it's", "don't", "you'll", and "can't". Full forms sound stiff and make se
**Write:** You can't recover a deleted secret, so you'll need to create it again.
-Vale reports the common full forms as suggestions.
+Vale reports the common full forms as errors.
### Read it out loud
@@ -701,12 +701,10 @@ em dashes in one paragraph, "click" and "tap" where the verb should be "select",
forms of common contractions. Vale doesn't check the `description` frontmatter field, so check
the description yourself when you review a page.
-Two of those rules don't fail the run yet. `Infisical.UIActions` reports at warning level and
-`Infisical.Contractions` reports at suggestion level, because existing pages have several
-hundred violations of each rule, and making either rule an error would fail every pull request
-that edits those pages. Both rules will become errors once the existing violations are fixed,
-so fix any violations on the pages you edit. Read the output Vale prints, not just the exit
-code.
+Every rule except the em dash rule reports at error level, so a finding from any other rule,
+including "click" and "tap" and the full forms of contractions, fails the run. The em dash rule
+reports at warning level and doesn't change the exit code, so read the output Vale prints, not
+just the exit code.
No automated check covers the two bold rules in section 11. Only a reviewer who knows the
product can tell whether a word is the name of a button that should be bold.