Welcome

These are the SwiftQ documentation. This will hopefully guide you through setting up your environment, adding new code changes and the policies that go with it.

The design, concepts and future goals will also be added here so that everyone starts off on the same page.

The documentation is using docz with material-ui

Adding pages

All pages should be under the ./pages directory. New folders can be added to keep the files "clean". Documentation should try to group documentation together e.g.

Pages /setup contains /environment and /installation. To set this up you only require the .mdx file to point to /setup/<name here> as shown inside ./setup/install.mdx and ./setup/environment.

When making big changes, like paths on a new file or changes to doczrc.js rerun the development command. See below :point_down:

Running development

npm run dev

Open the browser at http://localhost:3000

Deployment

NEVER PUSH TO MASTER.

Create a new branch and add all of your changes there. Then create a PR (pull request) to master branch, which will auto-deploy to https://develop.swiftq.app

Build

npm build

Serve built app