Skip to content

docs: add comprehensive glossary#7401

Merged
jdx merged 3 commits intomainfrom
docs/glossary
Dec 18, 2025
Merged

docs: add comprehensive glossary#7401
jdx merged 3 commits intomainfrom
docs/glossary

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Dec 18, 2025

Summary

  • Adds a glossary page with ~50 terms organized into categories
  • Covers Core Concepts, Backends, Shell Integration, Configuration, Environment Variables, Hooks, Tasks, Directories, and other mise-specific terminology
  • Placed in the "About" section of the sidebar navigation

Categories Included

  • Core Concepts - activation, backend, toolset, tool request, tool version, etc.
  • Backends - all 15 backend types (aqua, asdf, cargo, npm, pipx, etc.)
  • Shell Integration - shims, reshim, PATH activation, hook-env
  • Configuration - hierarchy, environments, templates, settings
  • Environment Variables - env._ directives, redaction, lazy evaluation
  • Hooks - all hook types (cd, enter, leave, preinstall, postinstall, watch_files)
  • Tasks - TOML tasks, file tasks, dependencies, dependency graph
  • Directories & Environment - MISE_DATA_DIR, MISE_CACHE_DIR, MISE_PROJECT_ROOT
  • Other Terms - aliases, direnv, mise-en-place, mise.lock, tool options

Test plan

  • Verify glossary renders correctly in docs site
  • Check all internal links work
  • Ensure glossary appears in About section of sidebar

🤖 Generated with Claude Code


Note

Adds a new glossary page and exposes it via an About-section sidebar link.

  • Docs:
    • New Page: Add comprehensive glossary at docs/glossary.md covering core concepts, backends, shell integration, configuration, env vars, hooks, tasks, directories, and other terms.
    • Navigation: Update VitePress config docs/.vitepress/config.ts to include Glossary under the About sidebar section.

Written by Cursor Bugbot for commit 219198b. This will update automatically on new commits. Configure here.

Adds a glossary page with ~50 terms organized into categories:
- Core Concepts (activation, backend, toolset, etc.)
- Backends (all 15 backend types)
- Shell Integration (shims, reshim, PATH activation)
- Configuration (hierarchy, environments, templates)
- Environment Variables (directives, redaction, lazy evaluation)
- Hooks (all hook types)
- Tasks (TOML tasks, file tasks, dependencies)
- Directories & Environment (MISE_DATA_DIR, etc.)
- Other Terms (aliases, direnv, mise-en-place)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
Copilot AI review requested due to automatic review settings December 18, 2025 22:53
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a comprehensive glossary to the mise documentation, providing definitions for approximately 50 terms organized into logical categories. The glossary serves as a central reference for understanding mise-specific terminology and concepts.

Key changes:

  • Created new glossary.md with 9 categorized sections covering core concepts, backends, shell integration, configuration, environment variables, hooks, tasks, directories, and miscellaneous terms
  • Added glossary link to the "About" section in the sidebar navigation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/glossary.md New glossary page with comprehensive definitions of mise terminology organized into categories
docs/.vitepress/config.ts Added glossary navigation link in the About section of the sidebar

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 x -- echo 19.7 ± 0.4 19.1 23.9 1.00
mise x -- echo 19.9 ± 0.4 19.1 22.7 1.01 ± 0.03

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 env 19.3 ± 0.5 18.7 26.2 1.00
mise env 19.5 ± 0.5 18.7 23.5 1.01 ± 0.04

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 hook-env 19.3 ± 0.7 18.7 27.2 1.00
mise hook-env 19.5 ± 0.3 18.9 21.4 1.01 ± 0.04

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.12.12 ls 16.9 ± 0.3 16.4 19.9 1.00
mise ls 17.3 ± 0.9 16.6 31.9 1.02 ± 0.06

xtasks/test/perf

Command mise-2025.12.12 mise Variance
install (cached) 109ms 110ms +0%
ls (cached) 66ms 66ms +0%
bin-paths (cached) 72ms 72ms +0%
task-ls (cached) 281ms 282ms +0%

@jdx jdx merged commit eab1a77 into main Dec 18, 2025
30 checks passed
@jdx jdx deleted the docs/glossary branch December 18, 2025 23:29
jekis913 added a commit to jekis913/mise that referenced this pull request Dec 19, 2025
* upstream/renovate/lockfile-maintenance:
  chore(deps): lock file maintenance
  fix(ci): improve GHA cache efficiency and fix registry-ci bug (jdx#7404)
  feat(tera): add haiku() function for random name generation (jdx#7399)
  feat: implement independent versioning for subcrates (jdx#7402)
  docs: add comprehensive glossary (jdx#7401)
  docs: improve installation documentation (jdx#7403)
  test: add token pool integration for rate limit distribution (jdx#7397)
  docs: add link to COPR package page for Fedora/RHEL
  test: rename duplicate 'ci' job names for clarity (jdx#7398)
  registry: add github backend for swiftformat (jdx#7396)
  chore: rename mise-tools to mise-versions
  chore: release 2025.12.12 (jdx#7386)
  fix(github): use version_prefix when fetching release for SLSA verification (jdx#7391)
  refactor(vfox): remove submodules, embed plugins directly (jdx#7389)
  test(registry): add final ci job as merge gate (jdx#7390)
  test: split unit job to speed up macOS CI (jdx#7388)
  feat(backend): add security features to github backend (jdx#7387)
jdx pushed a commit that referenced this pull request Dec 19, 2025
### 🚀 Features

- **(tera)** add haiku() function for random name generation by @jdx in
[#7399](#7399)
- implement independent versioning for subcrates by @jdx in
[#7402](#7402)

### 🐛 Bug Fixes

- **(ci)** improve GHA cache efficiency and fix registry-ci bug by @jdx
in [#7404](#7404)
- **(ci)** use !cancelled() instead of always() for registry-ci by @jdx
in [#7435](#7435)
- **(test)** update backend_arg test to use clojure instead of poetry by
@jdx in [#7436](#7436)

### 📚 Documentation

- add link to COPR package page for Fedora/RHEL by @jdx in
[bc8ac73](bc8ac73)
- improve installation documentation by @jdx in
[#7403](#7403)
- add comprehensive glossary by @jdx in
[#7401](#7401)

### 🧪 Testing

- rename duplicate 'ci' job names for clarity by @jdx in
[#7398](#7398)
- add token pool integration for rate limit distribution by @jdx in
[#7397](#7397)

### 📦 Registry

- add github backend for swiftformat by @jdx in
[#7396](#7396)
- use pipx backend for azure-cli by @jdx in
[#7406](#7406)
- use pipx backend for dvc by @jdx in
[#7413](#7413)
- add github backend for zprint by @jdx in
[#7410](#7410)
- use gem backend for cocoapods by @jdx in
[#7411](#7411)
- use pipx backend for gallery-dl by @jdx in
[#7409](#7409)
- add aqua backends for HashiCorp tools by @jdx in
[#7408](#7408)
- use npm backend for danger-js by @jdx in
[#7407](#7407)
- use pipx backend for pipenv by @jdx in
[#7415](#7415)
- use pipx backend for poetry by @jdx in
[#7416](#7416)
- add github backend for xcodegen
([github:yonaskolb/XcodeGen](https://github.com/yonaskolb/XcodeGen)) by
@jdx in [#7417](#7417)
- use npm backend for heroku by @jdx in
[#7418](#7418)
- add aqua backend for setup-envtest by @jdx in
[#7421](#7421)
- add github backend for xcresultparser
([github:a7ex/xcresultparser](https://github.com/a7ex/xcresultparser))
by @jdx in [#7422](#7422)
- add aqua backend for tomcat by @jdx in
[#7423](#7423)
- use npm backend for serverless by @jdx in
[#7424](#7424)
- add github backend for daytona
([github:daytonaio/daytona](https://github.com/daytonaio/daytona)) by
@jdx in [#7412](#7412)
- add github backend for flyway
([github:flyway/flyway](https://github.com/flyway/flyway)) by @jdx in
[#7414](#7414)
- add github backend for schemacrawler
([github:schemacrawler/SchemaCrawler](https://github.com/schemacrawler/SchemaCrawler))
by @jdx in [#7419](#7419)
- add github backend for codeql by @jdx in
[#7420](#7420)
- use pipx backend for mitmproxy by @jdx in
[#7425](#7425)
- use pipx backend for sshuttle by @jdx in
[#7426](#7426)
- add github backend for quarkus by @jdx in
[#7428](#7428)
- add github backend for smithy by @jdx in
[#7430](#7430)
- add github backend for xchtmlreport
([github:XCTestHTMLReport/XCTestHTMLReport](https://github.com/XCTestHTMLReport/XCTestHTMLReport))
by @jdx in [#7431](#7431)
- add github backend for grails by @jdx in
[#7429](#7429)
- use npm backend for esy by @jdx in
[#7434](#7434)
- add github backend for micronaut by @jdx in
[#7433](#7433)
- add github backend for dome by @jdx in
[#7432](#7432)
- use vfox backend for poetry by @jdx in
[#7438](#7438)

### Chore

- **(docker)** add Node LTS to mise Docker image by @jdx in
[#7405](#7405)
- rename mise-tools to mise-versions by @jdx in
[ab3e1b8](ab3e1b8)
- s/mise task/mise tasks/g in docs and tests by @muzimuzhi in
[#7400](#7400)

### New Contributors

- @muzimuzhi made their first contribution in
[#7400](#7400)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants