teamkeel/docs

Our docs site

Your production-grade backend from one file

Try it Out | Join our Discord

---

Documentation

This repo contains the documentation for Keel. It is a Next.js site built with the pages router. Every .mdx file in the pages directory represents a page in the docs.

Getting Started

Since this is just another Next.js project, you can get started by cloning the repo and running npm install to install the dependencies. Then, you can run npm run dev to start the development server.

Testing Broken Links

We make sure there are no broken links in these docs using Vitest. To run the link test (and other tests), run

npm run test

Vitest also runs on every PR branch, so you can check the status of the docs link test in the GitHub Actions tab, and take advantage of its --watch mode during local development.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tejas Kumar 📖 💻 ⚠️	Jay Meistrich 📖	Shedrack akintayo 📖	Dave New 📖	tomfrew 📖	Adam Bull 📖	Jon Bretman 📖 💻
David Blooman 📖	Jure 📖 💻	Emily Toop 📖	Louisa Spicer 📖	Andrew Lovett-Barron 📖	peterhoward42 📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

docs's Issues

Rewrite the Local Development guide in docs to cater for less tech-savvy folks.

Review the tutorial to reflect the new schema structure

We need better og:images

This post has no og:image, it's quite sad: https://twitter.com/keelteam/status/1719339791941071175

Let's add better og:images

Keel documentation Umbrella Issue

Brief

This issue is an umbrella tracking issue. Below is a list of checkboxes for individual items that need to be worked on. Content of this Issue will be pulled from the Docs ToDo list on Notion.

Please note that these timelines depend on whether there are no blockers or breaking changes from the Keel side of things that need to be addressed.

Site to Update:

https://docs.keel.so

Docs Todo List

https://www.notion.so/keelhq/Docs-ToDo-b23196b0b3124dbe9193f3707c7f737e?pvs=4

List of Issues

• #21
• #22
• #23

This list will continue to increase as we add more features to Keel, this is to ensure we have an Inventory for all docs changes and requests.

Review the new Actions documentation by Adam