Shdoc

v1.3 Breaking

This release includes breaking changes for platform teams planning a safe upgrade.

Published 3d Documentation

View tool

✓ No known CVEs patched

Read the diff → Tool health → What is this tool? →

✓ No known CVEs patched in this version

Summary

AI summary

Added deprecation annotation support, command-line help/ version flags, Vim syntax highlighting, EditorConfig, and formatting target.

Changes in this release

Type	Severity	Summary	CVE
Feature
Feature	Low	Adds @deprecated annotation support; deprecated functions render with notice. Adds @deprecated annotation support; deprecated functions render with notice. Source: llm_adapter@2026-06-01 Confidence: high	—
Feature	Low	Adds command-line help via `shdoc --help` and `shdoc -h`. Adds command-line help via `shdoc --help` and `shdoc -h`. Source: llm_adapter@2026-06-01 Confidence: high	—
Feature	Low	Adds version output via `shdoc --version`. Adds version output via `shdoc --version`. Source: llm_adapter@2026-06-01 Confidence: high	—
Feature	Low	Adds Vim syntax highlighting for shdoc annotations in `contrib/vim`. Adds Vim syntax highlighting for shdoc annotations in `contrib/vim`. Source: llm_adapter@2026-06-01 Confidence: high	—
Feature	Low	Adds `.editorconfig` file. Adds `.editorconfig` file. Source: llm_adapter@2026-06-01 Confidence: high	—
Feature	Low	Adds `make fmt` target for shell formatting with `shfmt`. Adds `make fmt` target for shell formatting with `shfmt`. Source: llm_adapter@2026-06-01 Confidence: high	—
Bugfix
Bugfix	Medium	Fixes rendering of `@see` entries containing multiple plain URLs. Fixes rendering of `@see` entries containing multiple plain URLs. Source: llm_adapter@2026-06-01 Confidence: high	—
Bugfix	Medium	Fixes GitHub anchor generation for function names with underscores; TOC links now preserve underscores. Fixes GitHub anchor generation for function names with underscores; TOC links now preserve underscores. Source: llm_adapter@2026-06-01 Confidence: high	—
Bugfix	Low	Fixes README typo: replaces `@arg` with correct `@option` in examples. Fixes README typo: replaces `@arg` with correct `@option` in examples. Source: llm_adapter@2026-06-01 Confidence: high	—
Refactor	Low	Updates README examples to use `#!/usr/bin/env bash` shebang. Updates README examples to use `#!/usr/bin/env bash` shebang. Source: granite4.1:30b@2026-06-01-audit Confidence: low	—
Refactor	Low	Formats shell examples and test fixtures. Formats shell examples and test fixtures. Source: granite4.1:30b@2026-06-01-audit Confidence: low	—

Full changelog

shdoc v1.3 release notes

Added

Added @deprecated annotation support.
- Deprecated functions now render with a deprecation notice prepended to the description.
Added command-line help:
- shdoc --help
- shdoc -h
Added version output:
- shdoc --version
Added Vim syntax highlighting for shdoc annotations under contrib/vim.
Added .editorconfig.
Added make fmt for shell formatting with shfmt.

Fixed

Fixed rendering of @see entries containing multiple plain URLs.
Fixed GitHub anchor generation for function names with underscores.
- Table-of-contents links now preserve underscores and match GitHub heading anchors.
- Fixes #79 and #84.
Updated README examples to use #!/usr/bin/env bash.
Fixed README typo where option examples incorrectly used @arg instead of @option.

Development

Added lint coverage for bash shebangs.
Formatted shell examples and test fixtures.

View diff on GitHub

Weekly OSS security release digest.

The CVE patches and breaking changes that affected production tools this week. One email, every Sunday.

No spam, unsubscribe anytime.

Share this release

Share on X Share on Bluesky

Track Shdoc

Get notified when new releases ship.

About Shdoc

All releases →