DevCycleHQ / devcycle-docs

DevCycle - Public Documentation

Devcycle Documentation!

This is the repository that backs https://docs.devcycle.com

This page is built using Docusaurus, and is hosted using Vercel.

Contributing

Setup

• Clone the repository
• run yarn
  • If yarn is not available, run brew install yarn
  • If on Windows, get yarn here

Linking to Vercel (DevCycle employees only)

• link vercel cli to your project yarn vercel link and follow the prompt
• download the environment variables yarn pull:env

Running locally

• run yarn dev

This will spin up a local version of the docs site for your usage.

Any changes made to the local code will automatically compile and update the local page while running.

Making Changes

• Make your changes locally on a new branch.
• Push your branch.
• Make pull request.
• Ask for a review from the DevCycle team.