Floe
AI writing assistants for docs and changelogs.
Overview
Floe is an AI writing assistant designed for the CLI/CI environment to assist users in creating technical content like documentation and changelogs with improved quality and reduced effort.
Features
- Reviews: Write custom rules in plain English for Floe to automatically review and provide feedback on your content.
- First Draft (Coming soon): Generate an initial draft of your content based on PR context and customizable templates.
Summary
Floe is an AI writing assistant tailored for the CLI/CI environment, offering features like content reviews and the upcoming first draft generation. It leverages technologies like Next.js, React.js, Tailwind CSS, Prisma.io, and Turborepo to provide a seamless experience for users. The project is open to contributions, and users can refer to the Floe documentation to begin using the tool effectively.
- Next.js
Next.js is a React-based web framework that enables server-side rendering, static site generation, and other powerful features for building modern web applications.
- Nextra
Nextra is a Next.js-based static site generator optimized for documentation and blogs. It provides MDX support, automatic sidebar generation, full-text search, and beautiful themes with minimal configuration.
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Planetscale
PlanetScale is a MySQL-compatible serverless database that brings you scale, performance, and reliability — without sacrificing developer experience.
- Prisma
Prisma is a server-side library that helps developers read and write data to the database in an intuitive, efficient and safe way.
- Fullstack
A fullstack boilerplate provides a starter application that includes both frontend and backend. It should include database, auth, payments, user roles and other backend services to build a fully featured saas or webapps.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Turborepo
Turbo is an incremental bundler and build system optimized for JavaScript and TypeScript, written in Rust.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Zod
Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.