diff --git a/docs/source/changelog/3.0.1.md b/docs/source/changelog/3.0.1.md index 48b7d24..93a9c82 100644 --- a/docs/source/changelog/3.0.1.md +++ b/docs/source/changelog/3.0.1.md @@ -1,12 +1,11 @@ -# 3.0.1 - Current Development - -*Note: This is the current development branch and is not yet released.* - -## What's New? +# 3.0.1 - Bugfix Release A few minor edge case bugfixes, and documentation improvements that were long overdue and missed the window for 3.0. +The {doc}`CLI Command Reference <../command_reference>` section of the +documentation, in particular, has been overhauled and looks much nicer now. + Some minor refactoring on internals were also performed to improve code quality and internal API robustness. @@ -22,9 +21,28 @@ quality and internal API robustness. ## Documentation +- Refresh README to cover 3.0+ project structure - Fix multiple grammar, structure and rendering issues - Update the Documentation index to be in sync with the README -- Document cache file locking mechanics in the appropriate section +- Document cache file locking mechanics in the {ref}`appropriate section ` - Fix issue with CLI Command Reference linking to wrong section anchors for subcommands sharing a name - Improve presentation of string literal boxes throughout the documentation +- Overhaul visual structure of the {doc}`CLI Command Reference <../command_reference>` + section. + +## What's Changed + +- Migrate codebase to ruff 0.16+ linting rules +- Add proper logger instance to textual app module +- Normalize Configuration load errors to ValueError +- Tests: do not patch logger where possible +- Runners: Do not forward stdin to remote commands +- Commands: use double backticks in docstrings +- Move general exception handling to Host object +- Docs: Fix minor grammar and render nits +- Docs: explicitly name links where inlined +- Docs: Fix command reference section anchors +- Docs: Improve string literal CSS +- Docs: Visually indent subcommands in CLI reference +- Docs: Refresh documentation post 3.0 release diff --git a/docs/source/spelling_wordlist.txt b/docs/source/spelling_wordlist.txt index fb376a5..6c5d657 100644 --- a/docs/source/spelling_wordlist.txt +++ b/docs/source/spelling_wordlist.txt @@ -6,6 +6,8 @@ autosave autosize backend backfilled +backtick +backticks boolean booleans bugfix @@ -48,6 +50,7 @@ github hostname hotfix init +inlined installonly ip janky diff --git a/pyproject.toml b/pyproject.toml index fe6bab9..93a2224 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "exosphere-cli" -version = "3.0.1.dev4" +version = "3.0.1" description = "CLI/TUI driven patch reporting for remote Unix-like systems." readme = "README.md" authors = [ diff --git a/uv.lock b/uv.lock index 388b7c3..1ea48e9 100644 --- a/uv.lock +++ b/uv.lock @@ -645,7 +645,7 @@ wheels = [ [[package]] name = "exosphere-cli" -version = "3.0.1.dev4" +version = "3.0.1" source = { editable = "." } dependencies = [ { name = "cyclopts" },