dr-phil / estuary-docs

https://docs.estuary.tech

Estuary documentation

This repo contains all the documentation for estuary.tech, along with the website build logic. If you're looking for the estuary.tech homepage repo, head to github.com/application-research/estuary-www.

Run locally

1. Clone this repo:

   git clone https://github.com/application-research/estuary-docs.git
   cd estuary-docs

2. Install dependencies:

   npm install

3. Start the local server:

   npm run dev

4. View the site in your browser at localhost:3005

5. Done!

Adding a page

1. Start by copying and renaming one of the pages from pages
2. Add your changes to the newly copied page, remember to change variable names
3. Add your page to components/Navigation.tsx so it appears on the menu on the left of the screen

Get support

Running into problems? Leave an issue, or join the #ecosystem-dev Slack.