Skip to content

Commit

Permalink
Minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
byronwasti committed Apr 19, 2024
1 parent 04fb6fd commit a959d08
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 14 deletions.
4 changes: 2 additions & 2 deletions balter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ async fn my_transaction() -> Result<u32, String> {

## Developer Notes

The Balter repository is set up to be easy to get started with development. It uses Nix to facilitate the environment setup via `shell.nix` (if you haven't yet drank the Nixaide, open up that file and it will give you an idea of the programs you'll want).
The Balter repository is set up to be easy to get started with development. It uses Nix to facilitate the environment setup via `shell.nix` (if you haven't yet drank the Nixaide, open up that file and it will give you an idea of the programs you'll want). Otherwise, Balter works just fine with all the default `cargo` commands.

To run the integration tests, use `just integration` (or if you don't have `just` installed, `cargo test --release --features integration`). In order to easily debug these tests (which oftentimes rely on controller logic operating correctly), it can be useful to have graphs. You can find Grafana dashboards for each test in `dashboards/`, and if you have Prometheus running (using the `prometheus.yml` at the root) and Grafana running (importing the dashboards) you should be set.
The integration tests can be a bit finicky. To run the integration tests, use `just integration` (or if you don't have `just` installed, `cargo test --release --features integration`). In order to easily debug these tests (which oftentimes rely on controller logic operating correctly), it can be useful to have graphs. You can find Grafana dashboards for each test in `dashboards/`, and if you have Prometheus running (using the `prometheus.yml` at the root) and Grafana running (importing the dashboards) you should be set.
3 changes: 1 addition & 2 deletions docs/content/blog/balter-0.5.0.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
+++
title = "Balter v0.5.0"
date = "2024-04-12"
authors = ["Byron Wasti"]
+++

# Balter v0.5.0

The release of Balter v0.5.0 comes with major core refactors and a major feature which rounds out the basic functionality for single-server operation.

# Latency Controller Added
Expand Down
10 changes: 0 additions & 10 deletions docs/content/external/frontpage_code.md

This file was deleted.

15 changes: 15 additions & 0 deletions docs/templates/page.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{% extends "juice/templates/page.html" %}

{% block header %}
<header class="box-shadow">
{{ macros::render_header() }}
</header>
{% endblock header %}

{% block content %}
<div style="display: flex; flex-direction: row; align-items: center">
<div class="heading-text">{{ page.title }}</div>
<h2 style="margin-left: 2em" class="subtext">{{page.authors.0}}, {{page.date}}</h2>
</div>
{{ page.content | safe }}
{% endblock content %}

0 comments on commit a959d08

Please sign in to comment.