Skip to content

Commit

Permalink
add heading anchors in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
shivaraj-bh committed Feb 24, 2024
1 parent 67355f5 commit 2e12b16
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions doc/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ order: -10

We use [emanote](https://emanote.srid.ca/) to render our documentation. The source files are in the `doc` directory.

## Run the doc server
{#run-doc}

Enter the [developement environment](https://community.flake.parts/services-flake/development#dev-shell) and run:
## Run the doc server

```sh
just doc
```

{#new-service}

## Add documentation for a new service

Create a new file `./doc/<service-name>.md` file (see [[clickhouse]] for example) and add the service to the list in [[services]].
Create a new file `./doc/<service-name>.md` (see [[clickhouse]] for example) and add the service to the list in [[services]].

> [!note]
> It is recommended to add documentation for non-trivial tasks. For example, grafana documentation mentions [how to change the default database backend](https://community.flake.parts/services-flake/grafana#change-database).

0 comments on commit 2e12b16

Please sign in to comment.