diff options
| author | Waldir Pimenta <waldyrious@gmail.com> | 2026-01-16 19:15:47 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-16 11:15:47 -0800 |
| commit | 901d010741485bff96d18b4c1706d87e269f436d (patch) | |
| tree | c39a7b0830e9dae1e9032c19bffff5f2b4f22253 /crates | |
| parent | Theming: explain how to set ANSI codes directly (#3065) (diff) | |
| download | atuin-901d010741485bff96d18b4c1706d87e269f436d.zip | |
docs: Various improvements to the `atuin import` docs (#3062)
Recreation of PR https://github.com/atuinsh/docs/pull/111, after the
migration of the docs to this repo (#3018).
Copying the description from that PR, for convenience:
This PR implements a few improvements to the import doc page.
1. **Fix name of `zsh-hist-db` and `xonsh-sqlite` subcommands**
The `atuin import` subcommands `zsh-hist-db` and `xonsh-sqlite`
were incorrectly documented as `zsh_histdb` and `xonsh_sqlite`,
respectively.
This is likely due to the actual modules that implement the import
functionality
being indeed named `zsh_histdb` and `xonsh_sqlite` (see
[here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin/src/command/client/import.rs#L14)
and
[here](https://github.com/atuinsh/atuin/blob/v18.10.0/crates/atuin-client/src/import/mod.rs#L19-L21)),
but for the end-user, that results in documentation that's confusing at
best,
and error-inducing at worst.
Fixes issue
[atuinsh/atuin#2533](https://github.com/atuinsh/atuin/issues/2533).
2. **Document the `powershell` and `replxx` import subcommands**
These importers were introduced in PRs
[atuinsh/atuin#2864](https://github.com/atuinsh/atuin/pull/2864) and
[atuinsh/atuin#2024](https://github.com/atuinsh/atuin/pull/2024),
respectively,
but the documentation was not updated to account for them.
3. **Fix alphabetic sorting of sections**
Move the `nu-hist-db` and `zsh-hist-db` sections to be after `nu` and
`zsh`, respectively.
This is more intuitive, and matches the existing sort used for the
`xonsh` / `xonsh-sqlite` sections.
4. **Minor whitespace correction**
Fix line wrapping in the `resh` section
~~and remove trailing whitespace in the `nu*` sections.~~
<!-- Thank you for making a PR! Bug fixes are always welcome, but if
you're adding a new feature or changing an existing one, we'd really
appreciate if you open an issue, post on the forum, or drop in on
Discord -->
## Checks
- [x] I am happy for maintainers to push small adjustments to this PR,
to speed up the review cycle
- [x] I have checked that there are no existing pull requests for the
same thing
Fixes #2533.
Diffstat (limited to 'crates')
0 files changed, 0 insertions, 0 deletions
