myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[docs] fix some links between config and commands (#733)

Browse source
This commit is contained in:
Maurice Escher 2023-02-27 09:12:00 +01:00 committed by GitHub
parent df9b3b0541
commit f3bc646f24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/commands/stats.md
View file

@ -8,7 +8,7 @@ little basic, but more features to come.
You provide the starting point, and Atuin computes the stats for 24h from that point. 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 Date parsing is provided by `interim`, which supports different formats
for full or relative dates. Certain formats rely on the dialect option in your for full or relative dates. Certain formats rely on the dialect option in your
[configuration](config.md#dialect) to differentiate day from month. [configuration](/docs/config/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. Refer to [the module's documentation](https://docs.rs/interim/0.1.0/interim/#supported-formats) for more details on the supported date formats.
``` ```

4
docs/docs/commands/sync.md
View file

@ -6,13 +6,13 @@ server operator can _never_ see your data!
Anyone can host a server (try `atuin server start`, more docs to follow), but I 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 host one at https://api.atuin.sh. This is the default server address, which can
be changed in the [config](config.md). Again, I _cannot_ see your data, and be changed in the [config](/docs/config/config.md#sync_address). Again, I _cannot_ see your data, and
do not want to. do not want to.
## Sync frequency ## Sync frequency
Syncing will happen automatically, unless configured otherwise. The sync Syncing will happen automatically, unless configured otherwise. The sync
frequency is configurable in [config](config.md) frequency is configurable in [config](/docs/config/config.md#sync_frequency)
## Sync ## Sync

6
docs/docs/config/config.md
View file

@ -23,7 +23,7 @@ See [config.toml](../atuin-client/config.toml) for an example
### `dialect` ### `dialect`
This configures how the [stats](stats.md) command parses dates. It has two This configures how the [stats](/docs/commands/stats.md) command parses dates. It has two
possible values possible values
``` ```
@ -193,9 +193,9 @@ or `py`.
### history_filter ### history_filter
The history filter allows you to exclude commands from history tracking - maybe you want to keep ALL of your `curl` commands totally out of your shell history, or maybe just some matching a pattern. The history filter allows you to exclude commands from history tracking - maybe you want to keep ALL of your `curl` commands totally out of your shell history, or maybe just some matching a pattern.
This supports regular expressions, so you can hide pretty much whatever you want! This supports regular expressions, so you can hide pretty much whatever you want!
``` ```
## Note that these regular expressions are unanchored, i.e. if they don't start ## Note that these regular expressions are unanchored, i.e. if they don't start