# n8n-docs is a GitBook site with CI that fails your prose before a reviewer reads it

> The documentation repository behind docs.n8n.io, where Vale lints prose and Lychee checks every link on each pull request, and where the license is fair-code rather than open source.

**n8n-io/n8n-docs** — Documentation for n8n, a fair-code licensed automation tool with a free community edition and powerful enterprise options. Build AI functionality into your workflows.

- Repository: https://github.com/n8n-io/n8n-docs
- Website: https://docs.n8n.io
- Stars: 1,809 · Forks: 4,285
- Language: Unknown
- License: NOASSERTION
- Published: 2026-10-07 · Updated: 2026-10-07 · Language: en
- Canonical page: https://hysenlabs.com/projects/n8n-io-n8n-docs

## What lives here, and what deliberately does not

This repository hosts the documentation for n8n, which the README describes as an extendable workflow automation tool enabling you to connect anything to everything. The published site is docs.n8n.io.

The README spends its second section redirecting readers elsewhere, and that list is the fastest way to understand the project's boundaries. Looking for the product's source code means going to the separate `n8n` repository. Wanting to try the product means n8n Cloud or self-hosting, with the self-hosting docs living on the site under hosting. Needing help is a forum matter, and feature requests have their own forum space.

So the split is clean: this repository holds the site source, and nothing else about the product. The tree reflects that, with 21 entries that are almost entirely documentation infrastructure. There is `docs/` for content, `document-templates/` for doc types, `styles/` for Vale rules, `feeds/`, `skills/`, and `.github/` for workflows and PR templates, alongside the root config files.

A few root files are worth noticing because they show where the project is heading. `CLAUDE.md` is present, so some of the writing or maintenance work is expected to happen with an agent in the loop. `context7.json` is the config for Context7, the service that feeds documentation into AI coding assistants. `REUSABLE_CONTENT_INDEX.md` suggests a deliberate move toward content that can be included from multiple places rather than duplicated. And `CNAME` is the custom domain binding for GitHub Pages, though the published site is served by GitBook.

## Vale and Lychee are the editorial gate, and they run in CI

The tech stack list is four items and two of them are about catching mistakes rather than building pages. GitBook is the documentation framework. Vale handles prose linting. Lychee handles broken link checking. GitHub Actions runs both Vale and Lychee in CI.

Prose linting in CI is the unusual choice here and the most useful thing to copy. Most documentation repositories rely on human review for style. This one makes the mechanical part mechanical, so a reviewer spends attention on whether a sentence is true rather than on whether it uses the passive voice. The rules themselves live in `styles/`, and `.vale.ini` at the root configures them, which means the house style is expressed as a versioned, diffable set of rules rather than as a paragraph of guidance.

Lychee closes the other common failure. A documentation site rots through dead links, and a link checker that runs on every pull request means the rot is caught at the moment someone introduces it. `lychee.toml` at the root holds its configuration.

Both tools run in GitHub Actions, which means the feedback loop is entirely server-side. There is no local invocation documented in the README, which is consistent with the next section's stance on local builds.

## No local preview, and that is a deliberate constraint

The README states it plainly: local build and preview of the n8n Docs site is not supported. If you are making changes locally, you push them and open a pull request, and GitBook automatically adds a preview link to each PR.

A documentation repository built on GitBook inherits this from the platform rather than choosing it, and the README does not pretend otherwise. But the honest reading is that this makes the contribution loop slower in exchange for removing an entire class of problem. There is no stale local environment, no mismatch between what you previewed and what shipped, and no node_modules to install, because the repository has no application to build.

The consequence for a contributor is that the local feedback you are used to does not exist. Instead, you rely on the Vale and Lychee results in CI, plus the GitBook preview link. The README compensates by pointing at a Contribution Guide hosted on docs.n8n.io itself, which covers the accepted types of contribution, the writing standards, the ways to submit changes, and the team's review process.

The directory layout in the README is a quick orientation for anyone arriving cold.

```
n8n-docs/
├── docs/                        # All documentation content
├── document-templates/          # Templates for doc types
├── styles/                      # Vale prose linting rules
├── .github/                     # CI workflows and PR templates
├── .vale.ini                    # Vale prose linter config
└── lychee.toml                  # Broken link checker config
```

Note what is absent from that listing: there is no `package.json`, no build script, and no dependency manifest. That absence is the clearest single indicator that this is a content repository rather than an application.

## Fair-code, and a license field that says nothing

The license section says n8n-docs is fair-code licensed under the Sustainable Use License, and links both the faircode.io definition and a license documentation page on docs.n8n.io. This matches the repository description, which calls n8n a fair-code licensed automation tool with a free community edition and powerful enterprise options.

What does not match is the repository's own license field, which reads NOASSERTION. The tree contains a `LICENSE.md`, and the README links the Sustainable Use License at the `n8n` repository rather than at this one. NOASSERTION is what GitHub reports when it cannot classify a license from the files it recognizes, and for a repository whose terms live on an external site that is expected rather than alarming.

The distinction still matters to anyone planning to reuse the content. Fair-code and open source are not synonyms, and the Sustainable Use License is the mechanism n8n uses to keep the community edition free while reserving commercial use of the hosted and enterprise offerings. The README's own phrasing, a free community edition plus enterprise options, is the accurate summary.

There is also a `CONTRIBUTOR_LICENSE_AGREEMENT.md` at the root, which tells you contributions are governed separately from the content license. Combined with `CODE_OF_CONDUCT.md` and the contribution guide, that is a fairly complete governance surface for a repository that contains no code.

## Fork counts say more about n8n than this repository does

One set of numbers deserves attention because it is unusual. The repository has roughly 1,778 stars and roughly 4,278 forks. A fork count nearly two and a half times the star count is not a normal shape for a code repository, and there is a straightforward explanation: documentation gets cloned.

The realistic uses are running your own docs site, translating it, or forking it to fix something locally. None of those require the star, and forking is the path of least resistance, which is why the ratio is inverted here. The 42 open issues are the more meaningful signal about maintenance load, and the last recorded push is 2026-09-19.

The repository also reports no detected primary language, which is consistent with a tree of markdown, configuration, and templates rather than an application.

For a reader deciding whether to spend time here, the honest summary is that this is infrastructure and process rather than product. The product is n8n itself, and its source lives in a different repository. What is worth studying in this one is the shape of a documentation operation that has chosen to automate its own quality gates: prose linted in CI, links checked in CI, preview generated on the server, and local builds declined outright.

## Conclusion

The interesting engineering in this repository is not the content, it is the refusal to review docs locally. There is no supported local build: the documented loop is push a branch, open a pull request, and read the result on the GitBook preview link that lands on it. Two consequences follow. First, Vale and Lychee are the actual editorial gate, and a contributor learns the house style by reading `styles/` rather than by copying a local setup. Second, the license is fair-code under the Sustainable Use License, and the repository's own license field reads NOASSERTION, which is a GitBook-hosting artifact rather than a signal about terms. If you want to contribute prose, start with `STYLE_GUIDE.md` and `document-templates/`, then read the contribution guide on docs.n8n.io, which the README treats as the authoritative version rather than the `CONTRIBUTING.md` in the tree.

## FAQ

### Where can I find n8n documentation?

The live documentation is at docs.n8n.io, and its source is this repository, where content lives in markdown files under `docs/` organised by topic. The README also points to n8n Cloud for trying the product, a self-hosting section for running it yourself, and the community forum for help.

### Is n8n truly free?

The community edition is free and n8n is described as fair-code licensed under the Sustainable Use License rather than as open source. Enterprise options and n8n Cloud are the paid tier, so free to self-host and free to run commercially are different questions and the license is what answers the second one.

### Is n8n outdated?

The documentation repository recorded its most recent push on 2026-09-19, and it tracks releases of the product rather than being the product itself, so its activity reflects how current the docs are. The product's own source is in the separate `n8n` repository, where version history is the better signal to check.

### Is n8n better than Zapier?

The documentation describes n8n as an extendable workflow automation tool that lets you connect anything to everything, and it can be self-hosted, which is the difference most often cited in its favour. Whether that beats Zapier depends on whether you need self-hosting, custom code steps, or a managed vendor, and this repository does not attempt the comparison itself.

## Sources

- [Issues](https://github.com/n8n-io/n8n-docs/issues)
- [n8n-io/n8n-docs on GitHub](https://github.com/n8n-io/n8n-docs)
- [Project website](https://docs.n8n.io)
- [README](https://github.com/n8n-io/n8n-docs/blob/main/README.md)

---

Hysen Labs editorial analysis, written from the project's own repository and release notes. Cite the canonical page: https://hysenlabs.com/projects/n8n-io-n8n-docs
