Skip to content
This repository has been archived by the owner on Apr 7, 2024. It is now read-only.

Add some docs changes #84

Merged
merged 3 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .floe/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
},
"rulesets": {
"docs": {
"include": ["apps/web/**/*.{md,mdx}"],
"include": ["apps/web/**/*.{md,mdx}", "./README.md"],
"rules": {
"spelling-and-grammar": "warn",
"docs-style": "warn"
Expand Down
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,47 @@
# Floe
> ✨ Coming Soon ✨
<p align="center" style="margin-top: 120px">

Floe is an AI writing assistant. Add it to your CICD pipeline to automatically write new docs and update existing ones. Plus, use AI prose linting to keep your docs consistent and on-brand.
<h3 align="center">Floe</h3>

[↗️ Website](https://www.floe.dev/)
<p align="center">
AI writing assistants for docs and changelogs.
<br />
<strong>✨ Now in open beta! ✨</strong>
<a href="https://floe.dev"><strong>Learn more »</strong></a>
<br />
<br />
<a href="https://join.slack.com/t/floedev/shared_invite/zt-1okoncyuu-_v9KaY7AjEQfKNj6O6qvVg">Slack<a>
·
<a href="https://floe.dev">Website</a>
·
<a href="https://github.com/Floe-dev/floe/issues">Issues</a>
</p>
</p>

[📅 Book a demo](https://cal.com/nic-haley/book-a-demo)
## About Floe

[📨 Contact](mailto:[email protected])
Floe is an AI writing assistant for your CLI / CI. Floe can help you to ship technical content, like docs and changelogs, with higher quality and less effort.

Floe ships with two core features:

- **Reviews**: Write your own rules, in plain English, to check your content for a variety of issues. Floe will automatically review your content and provide feedback.

- **First Draft**: Floe can generate a first draft of your content, based on PR context and templates you control.

## Built-with

- [Next.js](https://nextjs.org/)
- [React.js](https://reactjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [Prisma.io](https://prisma.io/)
- [Turborepo](https://turbo.build/repo/)
- [NextAuth](https://next-auth.js.org/)

## Getting started

Go checkout the [Floe docs](https://floe.dev/docs) to get started.

## Contact us

[📅 Book a demo](https://cal.com/nic-haley/book-a-demo)

[📨 Contact](mailto:[email protected])