https://github.com/nihaiden/aurora-docs

Last synced: 4 months ago
JSON representation

Docs for Aurora.

Host: GitHub
URL: https://github.com/nihaiden/aurora-docs
Owner: NiHaiden
License: apache-2.0
Created: 2024-12-10T11:44:56.000Z (5 months ago)
Default Branch: main
Last Pushed: 2025-01-15T20:03:32.000Z (4 months ago)
Last Synced: 2025-01-15T22:25:43.484Z (4 months ago)
Language: TypeScript
Homepage: http://docs.getaurora.dev/
Size: 5.2 MB
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

README

# 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
```