Early access

Meet your new AI-powered writing assistant. Floe is the CICD platform for writing better docs without the headache.

✍️ Write your own custom rules. In plain English.
🔧 Review and apply fixes automatically.
🔄 Run reviews in CI and apply suggestions.
CI example
Pencil illustration

Save time, all the time.

Take the grunt work out of writing. Floe is like assigning a writing assistant to every pull request.

Now available

Reviews

Write your own rules.
Find and fix issues linters can't.

.floe/rules/style-guide.md
- Use the Oxford comma
- Use inclusive language. Use 'they' instead of 'he' or 'she'
WARN📂 docs/prerequisites.mdx

style-guide @@8,8:
The Oxford comma is missing before 'and' in a list of items.
➖ macOS, Windows and Linux are supported.
➕ macOS, Windows, and Linux are supported.

style-guide @@20,20:
The word 'he' is not inclusive.
He can then install the package.
They can then install the package.
Coming soon

First Draft

Automatic content generation.
Write your first draft in seconds.

.floe/templates/changelog.md
# {{ai "Write a short and simple title."}}
## {{env.DATE}}

{{ai "Announce the major change. Don't use technical jargon. Your tone should be casual, but professional."}}
First Draft
January 24, 2024
Today we're releasing First Draft. Create templates for a variety of use-cases: changelogs, release notes, API references, etc. When you create a PR, First Draft will automatically populate the template using contextual information and AI.

Install

Get started in 5 minutes or less.

npm i -g @floe/cli@latest
floe init
# Add environment variables ...
floe review files

FAQ