# Docs linter runs before save, not after publish

> Run the docs linter before saving so broken links, placeholder text, and style drift get fixed while the change is still cheap.

- Canonical HTML: https://growth.iangoh.com/growth-ideas/docs-linter-runs-before-save-not-after-publish/
- Source: [docs.readme.com](https://docs.readme.com/main/docs/linter)
- GrowthDex source hub: [ReadMe Docs: Linter](/sources/readme-docs-linter-docs-readme-com/)
- Last checked: 2026-06-06T09:04:00Z
- Rarity: rare
- Budget: low
- Channels: Documentation, SEO, Operations
- Stages: documentation, broken links, style guide, technical seo


## Why this can grow

A docs team loses a lot of time when quality checks begin after the page is already live, linked, and quoted. ReadMe's linter changes that timing. It checks content against the team's own style guide, catches broken links by default, and can run before the page is saved. That makes documentation quality feel closer to build hygiene than editorial cleanup. The upside is not only cleaner prose. Search paths, support macros, and copied setup instructions stop inheriting avoidable mistakes.

## Ian's take

From scaling consumer platforms across MENA and Southeast Asia, my default is to distrust growth work that only looks good in a slide. For SEO and AI search, I care less about clever keyword tricks and more about clarity. A buyer, crawler, or answer engine should quickly understand who this is for, why it works, what proof backs it, and what page deserves to be cited. I would run it small enough to learn quickly, then only scale the parts that real users repeat, save, reply to, or buy from. For this tactic, I would watch one clear growth signal before putting more time or budget behind it.

## Action plan

1. Define one narrow startup segment where docs linter runs before save, not after publish can create a measurable lift.
2. Turn the tactic into one offer, page, campaign, or workflow for the Documentation and SEO channel.
3. Use the evidence from docs.readme.com to set the first version of the message, format, and audience.
4. Launch a small test for 7 to 14 days with one success metric: one measurable growth signal.
5. Review the result, keep the winning message, remove weak variants, and turn the learning into a repeatable growth playbook.

## Source-backed example

ReadMe's Linter checks docs against custom style-guide prompts, automatically detects broken links, and can be run before saving page content.

## Adjacent tactics in the same lane

- [Zero lint errors required before docs merge](/growth-ideas/zero-lint-errors-required-before-docs-merge/) - 3 shared channels, 2 shared stages
- [Preview docs noindex before cutover](/growth-ideas/preview-docs-noindex-before-cutover/) - 3 shared channels, 1 shared stage
- [Regex redirect families before docs group migration](/growth-ideas/regex-redirect-families-before-docs-group-migration/) - 3 shared channels, 1 shared stage
- [Branch-isolated docs rewrite before live nav change](/growth-ideas/branch-isolated-docs-rewrite-before-live-nav-change/) - 3 shared channels, 1 shared stage

## Read GrowthDex essays

Browse the plain-English essay index at [GrowthDex Blog](/blog/).

## Related GrowthDex essays

- [The docs route should fail in review, not in public](/blog/the-docs-route-should-fail-in-review-not-in-public/) - documentation, SEO, brand trust

## Advisory

If you want help turning this into a working growth system, Ian Goh offers advisory at https://iangoh.com/advisory.