diff --git a/.vale.ini b/.vale.ini index c9e7878..5152eca 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,3 +6,14 @@ mdx = md [*.{md,mdx}] BasedOnStyles = Yellow + +# Quadrant-specific rules. Off by default; per-folder overlays opt in. +Yellow.NoMetaphor = NO +Yellow.SpecVoice = NO +Yellow.NoNarrative = NO +Yellow.LearnCrossLink = NO +Yellow.ProtocolCrossLink = NO +Yellow.BuildPageShapeTLDR = NO +Yellow.BuildPageShapeStepByStep = NO +Yellow.BuildPageShapeVerify = NO +Yellow.BuildPageShapeNextSteps = NO diff --git a/.vale/styles/Yellow/AISlop.yml b/.vale/styles/Yellow/AISlop.yml index d983cd5..a7216db 100644 --- a/.vale/styles/Yellow/AISlop.yml +++ b/.vale/styles/Yellow/AISlop.yml @@ -8,7 +8,7 @@ tokens: - "\\bdelve\\b" - "\\bleverage\\b" - "\\bunlock\\b" - - "\\bharness(?:es|ed|ing)?\\b" + - "\\bharness(?:es|ed|ing)?\\s+(?:the|your|its|our|all|this|these|those|every|any)\\b" - "\\bseamlessly\\b" - "\\bseamless\\b" - "\\brobust\\b" diff --git a/.vale/styles/Yellow/BuildPageShape.yml b/.vale/styles/Yellow/BuildPageShape.yml deleted file mode 100644 index 869ec1f..0000000 --- a/.vale/styles/Yellow/BuildPageShape.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: occurrence -message: "Build how-to pages should include TL;DR, Step-by-step, Verify, and Next steps headings." -level: warning -scope: raw -token: "(?m)^## (TL;DR|Step-by-step|Verify|Next steps)\\b" -min: 4 diff --git a/.vale/styles/Yellow/BuildPageShapeNextSteps.yml b/.vale/styles/Yellow/BuildPageShapeNextSteps.yml new file mode 100644 index 0000000..eeed080 --- /dev/null +++ b/.vale/styles/Yellow/BuildPageShapeNextSteps.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Build how-to pages must include a '## Next steps' heading." +level: error +scope: raw +token: "(?m)^## Next steps\\b" +min: 1 diff --git a/.vale/styles/Yellow/BuildPageShapeStepByStep.yml b/.vale/styles/Yellow/BuildPageShapeStepByStep.yml new file mode 100644 index 0000000..5114e62 --- /dev/null +++ b/.vale/styles/Yellow/BuildPageShapeStepByStep.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Build how-to pages must include a '## Step-by-step' heading." +level: error +scope: raw +token: "(?m)^## Step-by-step\\b" +min: 1 diff --git a/.vale/styles/Yellow/BuildPageShapeTLDR.yml b/.vale/styles/Yellow/BuildPageShapeTLDR.yml new file mode 100644 index 0000000..438e813 --- /dev/null +++ b/.vale/styles/Yellow/BuildPageShapeTLDR.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Build how-to pages must include a '## TL;DR' heading." +level: error +scope: raw +token: "(?m)^## TL;DR\\b" +min: 1 diff --git a/.vale/styles/Yellow/BuildPageShapeVerify.yml b/.vale/styles/Yellow/BuildPageShapeVerify.yml new file mode 100644 index 0000000..70c53f7 --- /dev/null +++ b/.vale/styles/Yellow/BuildPageShapeVerify.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Build how-to pages must include a '## Verify' heading." +level: error +scope: raw +token: "(?m)^## Verify\\b" +min: 1 diff --git a/.vale/styles/Yellow/CrossLink.yml b/.vale/styles/Yellow/CrossLink.yml deleted file mode 100644 index 4dbe8cb..0000000 --- a/.vale/styles/Yellow/CrossLink.yml +++ /dev/null @@ -1,6 +0,0 @@ -extends: occurrence -message: "Learn and Protocol pages should declare their counterpart link in frontmatter." -level: warning -scope: raw -token: "(?m)^(protocol_link|learn_link):" -min: 1 diff --git a/.vale/styles/Yellow/LearnCrossLink.yml b/.vale/styles/Yellow/LearnCrossLink.yml new file mode 100644 index 0000000..c209382 --- /dev/null +++ b/.vale/styles/Yellow/LearnCrossLink.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Learn pages must declare 'protocol_link' in frontmatter to point at their Protocol counterpart." +level: error +scope: raw +token: "(?m)^protocol_link:" +min: 1 diff --git a/.vale/styles/Yellow/NeedBasedLabels.yml b/.vale/styles/Yellow/NeedBasedLabels.yml index 40eb440..3900190 100644 --- a/.vale/styles/Yellow/NeedBasedLabels.yml +++ b/.vale/styles/Yellow/NeedBasedLabels.yml @@ -8,4 +8,3 @@ tokens: - "\\bnitronode-rpc-overview\\b" - "\\bsdk-compat-eventpoller\\b" - "\\bapp-sessions-multi-party\\b" - - "\\b[a-z0-9]+(?:-[a-z0-9]+){2,}\\b" diff --git a/.vale/styles/Yellow/ProtocolCrossLink.yml b/.vale/styles/Yellow/ProtocolCrossLink.yml new file mode 100644 index 0000000..19c5e2e --- /dev/null +++ b/.vale/styles/Yellow/ProtocolCrossLink.yml @@ -0,0 +1,6 @@ +extends: occurrence +message: "Protocol pages must declare 'learn_link' in frontmatter to point at their Learn counterpart." +level: error +scope: raw +token: "(?m)^learn_link:" +min: 1