Skip to content

docs: add friendly hover tips for new terms - #3740

Merged
markovejnovic merged 7 commits into
mainfrom
docs/glossary
Jul 24, 2026
Merged

docs: add friendly hover tips for new terms#3740
markovejnovic merged 7 commits into
mainfrom
docs/glossary

Conversation

@markovejnovic

@markovejnovic markovejnovic commented Jul 24, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

No description provided.

@markovejnovic markovejnovic changed the title docs: add a glossary with hover tooltips across the docs docs: add beginner-friendly hover tooltips across the docs Jul 24, 2026
@markovejnovic

markovejnovic commented Jul 24, 2026

Copy link
Copy Markdown
Member Author
image

@markovejnovic markovejnovic changed the title docs: add beginner-friendly hover tooltips across the docs docs: add friendly hover tips for new terms Jul 24, 2026
@markovejnovic
markovejnovic marked this pull request as ready for review July 24, 2026 23:46
@markovejnovic
markovejnovic enabled auto-merge (squash) July 24, 2026 23:48
@greptile-apps

greptile-apps Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Adds globally available hover definitions for common documentation terms.

  • Enables abbreviation tooltips and automatic definition inclusion in MkDocs.
  • Adds the shared abbreviation glossary.
  • Updates Vale’s accepted vocabulary.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The MkDocs extensions are supported by the pinned dependencies, and the auto-appended abbreviation file resolves correctly in the documentation build.

Important Files Changed

Filename Overview
docs/mkdocs.yml Correctly enables supported tooltip, abbreviation, and snippet features with a valid include path.
docs/includes/abbreviations.md Adds well-formed single-line definitions for terms used throughout the documentation.
.vale/styles/config/vocabularies/Atuin/accept.txt Adds relevant vocabulary entries for the new documentation content.

Reviews (1): Last reviewed commit: "some better abbreviations" | Re-trigger Greptile

@markovejnovic
markovejnovic merged commit 7a15c81 into main Jul 24, 2026
28 checks passed
@markovejnovic
markovejnovic deleted the docs/glossary branch July 24, 2026 23:50
@ellie ellie mentioned this pull request Jul 27, 2026
Merged
ellie added a commit that referenced this pull request Jul 27, 2026
@ellie
chore(release): prepare for release 18.18.0 (#3759)
89217e2 
### Bug Fixes

- *(daemon)* Index synced history directly instead of malformed SQL
([#3627](#3627))
([#3641](#3641))
- *(deps)* Update unsound/vulnerable dependencies in Cargo.lock
([#3632](#3632))
- *(docs)* Repair every stale link in the repo
([#3727](#3727))
- *(docs)* Make the incorrect-decrypt-key error actionable
([#3609](#3609))
- *(hook)* Drop agent commands containing NUL bytes via NonNulStr
([#3589](#3589))
([#3660](#3660))
- *(import)* Survive corrupt entries instead of aborting the import
([#3721](#3721))
- *(init)* Fix include guard in Bash init script; chore(init): improve
inclusion of shell init scripts in Rust
([#3645](#3645))
- *(install)* Make /dev/tty authoritative for interactivity detection
([#3691](#3691))
- *(search)* Add `DbSearchMode`; correctly fall back to "fuzzy" in
non-interactive searches
([#3744](#3744))
- *(ui)* Calculate preview height based on command display width instead
of byte count ([#3678](#3678))
- *(win32)* Cargo-binstall package metadata
([#3673](#3673))
- Search functionality to respect character offsets and non-ASCII
([#3659](#3659))
- Quote argument-hint YAML values so Copilot CLI ≥1.0.65 loads all
skills ([#3613](#3613))
([#3614](#3614))
- Correct grammar in 'history last' help text
([#3430](#3430))
- Work around rust nightly warning on eyre bail
([#3680](#3680))
- Improve non-interactive TTY detection in install.sh
([#3315](#3315))
- Add /model hint to status bar
([#3687](#3687))
- Set correct umask for pty-proxy
([#3700](#3700))
- Atuin AI not erasing the input box before closing
([#3715](#3715))
- Show server status next to AI progress indicator
([#3723](#3723))
- Show full command when using AtuinOutput tool
([#3725](#3725))

### Documentation

- *(ai)* Add self hosting + slash command docs
([#3623](#3623))
- *(config)* Standardize TOML examples for config options
([#3441](#3441))
- Advise users to pass `--locked` when installing from Cargo
([#3630](#3630))
- Add docs for store_failed and default for enter_accept
([#2696](#2696))
- Serve docs.atuin.sh from this repo; remove Desktop docs
([#3684](#3684))
- Version docs.atuin.sh with mike (per-release + main)
([#3688](#3688))
- Hotfix bad path
([#3690](#3690))
- Document built-in bash-preexec
([#3651](#3651))
- Retheme docs.atuin.sh to the Atuin brand
([#3701](#3701))
- Bundle of improvements
([#3716](#3716))
- Remove ugly cards on landing page
([#3724](#3724))
- Fix broken README links
([#3696](#3696))
- Lint prose with Vale and gate it in CI
([#3726](#3726))
- Slightly nicer default config.toml order
([#2485](#2485))
- Kubernetes self-hosting documentation
([#3238](#3238))
- Add canonical Supported platforms page
([#3736](#3736))
- Add friendly hover tips for new terms
([#3740](#3740))
- Clarify how to uninstall shell integration
([#3741](#3741))

### Features

- *(ai)* Up/down to scroll through previously sent messages
([#3720](#3720))
- *(bash)* Bundle bash-preexec with Atuin; automatically load if no
other preexec backend is loaded
([#3650](#3650))
- *(search)* Add `--shell` option to `atuin search` to filter results by
shell ([#3658](#3658))
- *(search)* Syntax highlight commands in interactive search
([#3704](#3704))
- *(search)* Filter by shell in interactive search
([#3692](#3692))
- *(string)* EllipsizeExt -- General-purpose utility for adding ellipses
to strings ([#3639](#3639))
- Add 'yolo' setting to Atuin AI options
([#3637](#3637))
- Add `shell` field to history entries
([#3636](#3636))
- Add hickory-dns resolver for musl target to improve DNS resolution
([#3647](#3647))
- Add atuin stats --filter-mode
([#1737](#1737))
- More aggressive optimizations for dist release
([#3683](#3683))
- Capture zsh comments as history
([#3699](#3699))
- Allow injecting extra HTTP headers on sync server requests
([#3718](#3718))

### Miscellaneous Tasks

- *(atuin-common)* Add ellipsize_or_pad for unicode pad
([#3663](#3663))
- *(ci)* Bump GitHub Actions to latest versions
([#3689](#3689))
- *(ci)* Lint tests & docs in CI
([#3746](#3746))
- *(clap)* Simplify clap field types and fix help message formatting
([#3640](#3640))
- *(logging)* Refactor logging
([#3622](#3622))
- *(release-skill)* Time label-gated PR merges around the release
([#3654](#3654))
- Remove fossier ([#3629](#3629))
- Trigger docs repo deploy
([#3631](#3631))
- Remove redundant test
([#3635](#3635))
- Add `.editorconfig` and `.nvim.lua`
([#3648](#3648))
- Clean up `WordJumper` in atuin/src/command/client/search/cursor.rs
([#3662](#3662))
- Don't panic if clipboard cannot be accessed
([#2648](#2648))
- Update some dependency versions
([#3666](#3666))
- Update sqlx to v9
([#3668](#3668))
- Follow-up on #1737
([#3649](#3649))
- Update Atuin AI to eye-declare v0.6.1
([#3686](#3686))
- Remove docs-dispatch
([#3694](#3694))
- Docker healtcheck
([#2451](#2451))
- Run windows jobs on depot-windows-2025-16
([#3711](#3711))
- Hotfix script ([#3714](#3714))
- Update flake.nix
([#3509](#3509))
- Add Timezone and restart policy for postgres backup docker
([#3083](#3083))
- Add riscv64 to release targets
([#3339](#3339))
- Build x86_64-apple-darwin on Depot M4 macs; move all macOS CI to Depot
([#3742](#3742))

### Performance

- Do not block counting history
([#3729](#3729))
- Actually delete history rows, and index active history
([#3730](#3730))
- Index filtered history search, record store tags, and cache inspector
stats ([#3731](#3731))

### Refactor

- *(hook)* Typed protocol for agent hook events
([#3638](#3638))
- *(render)* Slightly nicer and more correct non-printable escaping
([#3633](#3633))
- *(sync)* Remove deprecated V1 sync protocol
([#3634](#3634))
- Use typed Url instead of hand-built string URLs
([#3644](#3644))
- Extract shared vt100 logic into atuin-common
([#3664](#3664))

### Styling

- Improve Atuin AI TUI styles
([#3710](#3710))

### Testing

- Parametrize tests with rstest across 8 crates
([#3653](#3653))

### Bug

- Fix enter_accept default
([#3717](#3717))
- Abort install.sh on cURL fails
([#2911](#2911))
@scottames-github-bot scottames-github-bot Bot mentioned this pull request Aug 3, 2026
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@markovejnovic