Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 620 Bytes

README.md

File metadata and controls

31 lines (20 loc) · 620 Bytes

Aurora Docs

These docs are pretty sparse on purpose as Aurora is intended to be invisible. Ideally, the docs should be able to be consumed in one sitting.

Guidelines

  • Docs linking to upstream documentation directly with a short summary is preferred.
  • There's likely a reason why something is undocumented.

Previewing your changes

You've made some changes and want to see how they look?

You can install node and run it:

npm run i
npm run start

Alternatively, you can run the container:

docker compose up

Then make sure to format all your files with Prettier!

npm run prettier