Skip to content

docs: add getting started section to development.md #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 30, 2025
Merged

docs: add getting started section to development.md #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions pages/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
# Development

## Getting Started

First follow the [installation instructions](installation.md) to install the
required prerequisites.

To build Expert, run:

```sh
MIX_ENV=dev just release-local
```

>[!IMPORTANT]
> We set `MIX_ENV=dev` to disable Burrito's caching mechanisms. This provides a
> smoother development experience but expect server load times to be slightly
> longer.

You may point your editor's LSP configuration to path provided by Burrito, eg:

```sh
<your-repo>/apps/expert/burrito_out/expert_linux_amd64
```

## Logging

When expert starts up, it creates a `.expert` directory in the root
Expand Down
Loading