Skip to content

v1.3.0 - Documentation Commands Redesign

Choose a tag to compare

@butttons butttons released this 20 Jan 04:50
· 23 commits to main since this release
f4779c2

🚨 Breaking Changes

  • Remove dora docs find command - Use dora symbol or dora file instead, which show a documented_in field

✨ Features

  • Redesign docs commands for better usability
    • Add dora docs list command to show all documentation files
    • Add --type flag to filter docs by md/txt
    • Use documented_in field in symbol/file commands for finding where code is documented
    • Cleaner API: dora docs (list), dora docs search (search), dora docs show (metadata)

🐛 Bug Fixes

  • Improve docs command data quality
  • Filter empty symbol names in output
  • Better symbol lookup without strict line number matching
  • Improved fallback behavior with fuzzy search

📝 Documentation

  • Add VHS demo tapes for documentation GIFs
  • Update all documentation across README, website, and templates

Migration Guide

Before (v1.2.x):
```bash
dora docs find AuthService # Find docs mentioning symbol
dora docs find src/auth/service.ts # Find docs referencing file
```

After (v1.3.0):
```bash
dora symbol AuthService # Shows documented_in field
dora file src/auth/service.ts # Shows documented_in field
dora docs # List all documentation
dora docs search "auth" # Search documentation content
```

See full changelog: https://github.com/butttons/dora/blob/main/CHANGELOG.md#130