Skip to content

Releases: DandyLyons/treedocs

treedocs 0.2.0

22 Jun 18:21
@DandyLyons DandyLyons
0.2.0
156df9f

Choose a tag to compare

View all tags
treedocs 0.2.0 Latest
Latest

Highlights

  • Releases the treedocs CLI as version 0.2.0.
  • Publishes canonical treedocs.yaml schema 0.2.0 at https://dandylyons.github.io/treedocs/schemas/0.2.0/treedocs.schema.json.
  • Moves the public latest schema endpoint to schema 0.2.0.
  • Keeps distribution source-only through SwiftPM-backed tooling. No prebuilt artifacts are included in this release.

Schema 0.2.0

  • Improve Intellisense hints on treedocs.schema.json. Now when you edit your treedocs.yaml in editors like VS Code, you should have more helpful docs and code completion.
  • We now consistently use _ prepended strings for our reserved keys. This should make it easier to avoid accidental name collisions with reserved keys for treedocs. Simply avoid naming files or folders with _ at the beginning. (Not a perfect solution. Hopefully we'll add something better in the future.)
    • Renames tree-entry object metadata keys from description / references to _description / _references.
  • Keeps compact string descriptions unchanged.
  • Keeps _doc and _link reserved metadata keys unchanged.
  • Reserves underscore-prefixed keys inside tree for treedocs metadata, allowing real filesystem entries named description/ and references/.

Compatibility

  • The 0.2.0 CLI can still read, validate, sync, and update schema_version: "0.1.0" files using the 0.1.0 metadata keys.
  • 0.1.0 files are deprecated and commands warn with a pointer to DOCS/Migrating treedocs.yaml 0.1.0 to 0.2.0.md.
  • The 0.1.0 schema remains bundled for compatibility.

Verification

  • swift build passed.
  • swift test passed with 111 tests.
  • treedocs check passed.
  • A fresh treedocs init --non-interactive writes schema_version: 0.2.0.
Assets 2
Loading

treedocs 0.1.0

17 Jun 16:37
@DandyLyons DandyLyons
0.1.0
a559b3a

Choose a tag to compare

View all tags
treedocs 0.1.0

Initial public release 🎉

treedocs helps people and AI agents understand codebases faster by keeping a concise, version-controlled map of your repository in treedocs.yaml.

Highlights:

  • Generate readable tree documentation for files and folders.
  • Keep documentation synchronized with the filesystem using treedocs sync.
  • Detect stale, missing, or invalid documentation with treedocs check.
  • Explore codebases progressively with treedocs explore.
  • Search documented paths and descriptions with treedocs path.
  • Inspect links, aliases, and subtrees with treedocs inspect and treedocs show.
  • Store structured descriptions, references, and links in a schema-backed treedocs.yaml file.
  • Use the interactive terminal UI to fill in missing descriptions manually, or let AI agents help draft them.
  • Validate against the published JSON Schema for editor, CI, and tooling support.

Install note: treedocs is source-build only for now. The package targets macOS 13+, but installing through Homebrew, Mint, or mise requires a Swift 6-capable build environment, usually Xcode 16+. Prebuilt binaries may be added in the future if enough users want them.

Feedback is much appreciated. Let us know how you are using it in the wild.

The best places to find information, updates, and project news are:

Loading