Releases: zzstoatzz/mdxify
v0.2.34
What's Changed
Bug Fixes
- Prevent unnecessary docs.json updates when content unchanged (#30) - @zzstoatzz
This release fixes an issue where mdxify would create PRs that only add newlines to docs.json, even when the actual content hasn't changed. The tool now:
- Compares actual data structures instead of string representations
- Only writes files when content has actually changed
- Shows a friendly '✨ No changes needed' message when content is already up to date
Full Changelog: v0.2.33...v0.2.34
v0.2.33
Fix: Prevent deletion of docs when modules can't be found (#28) * fix: prevent deletion of docs when modules can't be found - Add safety check to only clean up stale files when modules are successfully discovered - Add warning message when no modules are found with helpful troubleshooting tips - Add comprehensive integration tests for Prefect and FastMCP doc generation - Add GitHub Actions workflow to test on both Linux and macOS - Fixes issue where running mdxify as a tool without target package would delete all docs This addresses the issue reported where Prefect's CI was deleting all docs when mdxify was installed as a tool without access to the Prefect package. 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com> * fix: CI workflow for integration tests - Run test projects in /tmp to avoid package discovery from workspace - Use mdxify directly (not uvx) when testing tool installation - Check for both regular and __init__ file naming patterns - Add debug output and success messages for clarity * fix: CI test should install package before running mdxify - Use --force when installing mdxify tool to ensure using current source - Install test package with uv pip install -e before running mdxify - Check for both regular and __init__ naming patterns - Add directory listing for debugging * simplify: CI test to focus on error message verification - Remove complex tool installation test that was failing - Simply verify mdxify shows helpful error when module not found - This is the core fix we're testing - preventing deletion * fix: add --system flag to uv pip install in CI * test: focus CI on the critical deletion prevention fix - Test that existing docs are NOT deleted when modules can't be found - This is the core issue reported in Prefect's CI - Simplify test to avoid complex environment setup issues --------- Co-authored-by: Claude <noreply@anthropic.com>
version banner
What's Changed
- docs: consolidate top-level docs by @zzstoatzz in #22
- docs: switch README to uvx usage and document Markdown support by @zzstoatzz in #25
- Display CLI version banner by @zzstoatzz in #27
Full Changelog: v0.2.31...v0.2.32
v0.2.31
What's Changed
Features
- ✨ Improved timing display precision - now shows 3 decimal places for better accuracy
- 📊 Enhanced progress bar with context-aware descriptions:
- Shows "Updating docs" when all files exist
- Shows "Processing docs" for mixed scenarios
- Shows "Generating docs" when creating new files
- 📝 Better summary messages that distinguish between creates and updates
Improvements
- More precise timing information for fast operations
- Clearer feedback about what mdxify is actually doing
- Better user experience with contextual progress messages
Full Changelog: v0.2.30...v0.2.31
v0.2.30 - Progress Bar Enhancement
What's New
✨ Progress Bar for Documentation Generation
Added a clean, dependency-free progress bar that shows during documentation generation:
- Displays current progress with visual bar using unicode characters
- Shows elapsed time and estimated time remaining
- Automatically activates in non-verbose mode
- No external dependencies - uses only built-in Python
Example
Generating docs: [██████████████████░░░░░░░░░░░░] 6/9 (67%) | 0.0s elapsed | ~0.0s remaining
This enhancement improves the user experience by providing clear feedback during the documentation generation process.
Testing Note
This release was created to test the new CreateRelease
tool being added to the GitHub MCP server (PR: github/github-mcp-server#1015).
v0.2.29
What's Changed
🐛 Bug Fixes
- Clean up stale MDX files when using
--all
flag (#19)- When modules are renamed or deleted, old documentation files are now automatically removed
- Only affects files belonging to the root module being regenerated
- Ensures output directory stays in sync with current codebase
Example
When renaming module.old_name
to module.new_name
, running mdxify --all
will now remove the stale module-old_name.mdx
file.
Full Changelog: v0.2.28...v0.2.29
v0.2.28
What's Changed
- feat: add --version/-V flag to CLI by @zzstoatzz in #17
Full Changelog: v0.2.27...v0.2.28
v0.2.27
Full Changelog: v0.2.26...v0.2.27
v0.2.26
Full Changelog: v0.2.25...v0.2.26
v0.2.25
Full Changelog: v0.2.24...v0.2.25