Skip to content

Commit

Permalink
fix(docs): fixes a bunch of dead links (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
YummyOreo authored Jan 16, 2024
1 parent 550ff97 commit ba6fa5c
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion src/content/docs/configuration/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ key = "~/.atuin-session"

### `dialect`

This configures how the [stats](../commands/stats.md) command parses dates. It has two
This configures how the [stats](/reference/stats.md) command parses dates. It has two
possible values

```
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/configuration/key-binding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ filter_mode_shell_up_key_binding = "directory" # or global, host, directory, etc

Our default up-arrow binding can be a bit contentious. Some people love it, some people hate it. Many people who found it a bit jarring at first have since come to love it, so give it a try!

It becomes much more powerful if you consider binding a different filter mode to the up arrow. For example, on "up" Atuin can default to searching all history for the current directory only, while ctrl-r searches history globally. See the [config](https://atuin.sh/docs/config/#filter_mode_shell_up_key_binding) for more.
It becomes much more powerful if you consider binding a different filter mode to the up arrow. For example, on "up" Atuin can default to searching all history for the current directory only, while ctrl-r searches history globally. See the [config](/configuration/config/#filter_mode_shell_up_key_binding) for more.

Otherwise, if you don't like it, it's easy to disable.

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/guide/sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ risks of the server snooping on you.
If you don't have an account, please [register](#register). If you have already registered,
proceed to [login](#login).

**Note:** You first have to set up your `sync_address` if you want to use a [self hosted server](#using-a-self-hosted-server).
**Note:** You first have to set up your `sync_address` if you want to use a [self hosted server](/self-hosting/server-setup/).

## Register

Expand Down Expand Up @@ -73,7 +73,7 @@ Syncing will happen automatically in the background, but you may wish to run it
atuin sync
```

Or, if you see missing data, force a full sync with:
Or, if you see missing data, force a full sync with:

```
atuin sync -f
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Alternatively, get in touch on our [Discord](https://discord.gg/Fq8bJSKPHh) or o
- bash
- fish
- nushell

## Quickstart

Please do try and read this guide, but if you're in a hurry and want to get
Expand All @@ -39,15 +39,15 @@ atuin import auto
atuin sync
```

Now restart your shell!
Now restart your shell!

Anytime you press ctrl-r or up, you will see the Atuin search UI. Type your
query, enter to execute. If you'd like to select a command without executing
it, press tab.

You might like to configure an [inline
window](https://atuin.sh/docs/config/#inline_height), or [disable up arrow
bindings](https://atuin.sh/docs/key-binding#disable-up-arrow)
window](https://docs.atuin.sh/configuration/config/#inline_height), or [disable up arrow
bindings](https://docs.atuin.sh/configureation/key-binding#disable-up-arrow)

<LinkCard
title="Installation"
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/reference/gen-completions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Possible values for the `--shell` argument are the following:
- `powershell`
- `elvish`

Also, see the [supported shells](https://atuin.sh/docs/#supported-shells).
Also, see the [supported shells](https://github.com/atuinsh/atuin#supported-shells).
2 changes: 1 addition & 1 deletion src/content/docs/reference/stats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ little basic, but more features to come.
You provide the starting point, and Atuin computes the stats for 24h from that point.
Date parsing is provided by `interim`, which supports different formats
for full or relative dates. Certain formats rely on the dialect option in your
[configuration](../../docs/config/config.md#dialect) to differentiate day from month.
[configuration](/configuration/config.md#dialect) to differentiate day from month.
Refer to [the module's documentation](https://docs.rs/interim/0.1.0/interim/#supported-formats) for more details on the supported date formats.

```
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/reference/sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ server operator can _never_ see your data!

Anyone can host a server (try `atuin server start`, more docs to follow), but I
host one at https://api.atuin.sh. This is the default server address, which can
be changed in the [config](/docs/config/config.md#sync_address). Again, I _cannot_ see your data, and
be changed in the [config](/configuration/config#sync_address). Again, I _cannot_ see your data, and
do not want to.

## Sync frequency

Syncing will happen automatically, unless configured otherwise. The sync
frequency is configurable in [config](/docs/config/config.md#sync_frequency)
frequency is configurable in [config](/configuration#sync_frequency)

## Sync

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/self-hosting/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Kubernetes

You could host your own Atuin server using the Kubernetes platform.

Create a [`secrets.yaml`](../../../k8s/secrets.yaml) file for the database credentials:
Create a [`secrets.yaml`](https://github.com/atuinsh/atuin/blob/main/k8s/secrets.yaml) file for the database credentials:

```yaml
apiVersion: v1
Expand All @@ -22,7 +22,7 @@ stringData:
immutable: true
```
Create a [`atuin.yaml`](../../../k8s/atuin.yaml) file for the Atuin server:
Create a [`atuin.yaml`](https://github.com/atuinsh/atuin/blob/main/k8s/atuin.yaml) file for the Atuin server:

```yaml
---
Expand Down Expand Up @@ -167,7 +167,7 @@ spec:
storage: 10Mi
```

Finally, you may want to use a separate namespace for atuin, by creating a [`namespaces.yaml`](../../../k8s/namespaces.yaml) file:
Finally, you may want to use a separate namespace for atuin, by creating a [`namespaces.yaml`](https://github.com/atuinsh/atuin/blob/main/k8s/namespaces.yaml) file:

```yaml
apiVersion: v1
Expand Down

0 comments on commit ba6fa5c

Please sign in to comment.