Releases: Thomo1318/jjConfig
Releases · Thomo1318/jjConfig
v3.3.0
v3.2.3
What's Changed
- ci(docs): add workflow_dispatch trigger for manual deployment by @Thomo1318 in #16
- feat(init): auto-generate mise.toml on repository initialization by @Thomo1318 in #17
- test: verify Badgetizr workflow by @Thomo1318 in #19
Full Changelog: v3.2.2...v3.2.3
Contributors
Thomo1318
Assets 2
v3.2.2 - Hugo Theme Submodule Fix
What's Changed
- fix(docs): add Relearn theme as Git submodule by @Thomo1318 in #15
Full Changelog: v3.2.1...v3.2.2
Contributors
Thomo1318
Assets 2
v3.2.1 - Hugo CI Fix
What's Changed
- fix(ci): update docs workflow to use Hugo instead of MkDocs by @Thomo1318 in #14
Full Changelog: v3.2.0...v3.2.1
Contributors
Thomo1318
Assets 2
v3.2.0 - Hugo Docs with Vapor Theme
What's Changed
- feat(docs): migrate to Hugo with Relearn theme and Vapor aesthetic by @Thomo1318 in #13
Full Changelog: v3.1.0...v3.2.0
Contributors
Thomo1318
Assets 2
v3.1.0 - Docs Site & Vapor Theme
What's Changed
- feat(security): add git-confirm pre-commit hook to jj init (v1.1.2) by @Thomo1318 in #6
- feat: validate and fix publication workflow artifacts by @Thomo1318 in #7
- feat(config): implement conventional commits and optimize trunk by @Thomo1318 in #8
- docs: reconcile version history (v3.0.1) by @Thomo1318 in #10
- feat(docs): v3.1.0 documentation site by @Thomo1318 in #11
Full Changelog: v1.2.0-repomix-integration...v3.1.0
Contributors
Thomo1318
Assets 2
v3.0.0 - Conventional Commits & Quality
Features
- Conventional Commits: Implemented template and validation.
- Trunk Optimization: Enabled Ruff, Codespell, Trivy.
- UI: detailed pager configuration (Gold Standard).
- Docs: Centralized documentation in .
Fixes
- Consolidated READMEs.
- Automated sanitization workflow.
v1.1.1 - GitHub Integration
v1.1.1 - GitHub Integration
🎉 What's New
GitHub CLI Integration with Interactive Prompts
Streamlined GitHub repository management directly from jj with three new commands:
jj gh-create- Create GitHub repositories interactivelyjj init-github- Initialize jj repo and create GitHub repo (all-in-one)jj gh-clone- Clone GitHub repos and initialize with jj
✨ Key Features
Smart & Dynamic
- Dynamic username detection - No hardcoded usernames, works for any authenticated user
- Auto-description generation - Intelligently extracts descriptions from README.md, package.json, pyproject.toml, or Cargo.toml
- Interactive prompts - Choose repository visibility (public/private) with confirmation
Robust & Reliable
- Comprehensive error handling - Validates dependencies (gh, jj, git) and authentication
- Input validation - Ensures repository names follow GitHub conventions
- Colored output - Clear visual feedback with info, success, warning, and error messages
Maintainable & Extensible
- External script approach - Separate
gh-helper.shscript for easy editing and testing - Modular design - Clean functions following bash best practices
- Well documented - Comprehensive inline comments and separate README
📦 Installation
# Scripts are already in ~/.config/jj/scripts/ (via symlink)
# Just ensure GitHub CLI is authenticated
gh auth login
# Test the new commands
jj gh-create --help🎨 Usage
# Create a new GitHub repo (interactive)
jj gh-create
# Initialize jj repo and create GitHub repo (all-in-one)
jj init-github
# Clone and initialize with jj
jj gh-clone owner/repo📊 Improvements
This implementation uses an external script approach instead of inline bash for:
- ✅ Better error handling and validation
- ✅ Dynamic username detection (no hardcoding)
- ✅ Multi-source description generation
- ✅ Easier testing and maintenance
- ✅ Better user experience with colors and confirmations
🔗 Files Added/Modified
New Files
scripts/gh-helper.sh- Main helper scriptscripts/README.md- Scripts documentationIMPLEMENTATION.md- Implementation details
Modified Files
config.toml- Added gh-create, init-github, gh-clone aliasesTASKS.md- Marked TODO 4 as implemented
🚀 Future Enhancements
- v1.2.0-security: Automatic commit signing
- v2.0: GitHub CLI extension
- v3.0: Task runner integration for CI/CD
📚 References
Full Changelog: v1.1.0...v1.1.1-gh-integration
v1.2.0 - Repomix Integration & Documentation Overhaul
Release Notes - v1.1.0 Documentation Update
Date: November 8, 2025
Version: v1.1.0-docs-update
Status: Ready for Release
📋 Overview
Comprehensive documentation overhaul to improve clarity, usability, and professionalism. This update introduces four new documentation files and enhances the existing README with modern formatting, badges, and comprehensive content.
✨ What's New
🆕 New Documentation Files
1. QUICKSTART.md (2.3 KB)
Purpose: Get new users up and running in 5 minutes
Contents:
- Prerequisites checklist
- 2-minute installation steps
- First repository creation guide
- Essential command reference table
- Basic workflow example
- TUI tool launchers
- Next steps and resources
Target Audience: New users, quick reference seekers
2. CONTRIBUTING.md (5.5 KB)
Purpose: Developer guidelines and contribution process
Contents:
- Development setup instructions
- Making changes guidelines (config, docs, features)
- Testing procedures (syntax validation, functional testing)
- Backup strategy and version numbering
- Pull request process with templates
- Code style guidelines (TOML, Shell, Markdown)
- Issue reporting and feature request templates
- Getting help resources
Target Audience: Contributors, developers, maintainers
3. TROUBLESHOOTING.md (7.4 KB)
Purpose: Common issues and solutions
Contents:
- Installation issues (symlink, permissions, Makefile)
- Configuration issues (loading, syntax, overrides)
- GitMCP issues (hooks, context files, URLs, failures)
- Color scheme issues (not showing, wrong colors, terminal support)
- Alias issues (not found, not working, TUI tools)
- Git integration issues (push, fetch, colocated repos)
- Performance issues (slow log, slow diff, memory usage)
- Debug logging and system info commands
- Issue reporting guidelines
Target Audience: Users experiencing problems, troubleshooters
🔄 Enhanced Documentation Files
README.md (25.8 KB)
Improvements:
- ✅ Added GitHub badges (License, Version, jj compatibility, PRs welcome)
- ✅ Added feature highlights with emojis for quick scanning
- ✅ Added comprehensive Table of Contents
- ✅ Added Prerequisites section with version requirements and optional dependencies
- ✅ Added Quick Start section linking to QUICKSTART.md
- ✅ Enhanced Installation section with step-by-step instructions
- ✅ Added comprehensive Usage section with command examples
- ✅ Added Configuration section explaining main config and reference files
- ✅ Added GitMCP Integration section with setup instructions
- ✅ Added detailed Directory Structure visualization
- ✅ Added Version History table with roadmap
- ✅ Added Contributing and Troubleshooting links
- ✅ Added Acknowledgments and Additional Resources sections
- ✅ Added footer with call-to-action
Before: 1.3 KB (basic info)
After: 25.8 KB (comprehensive guide)
📊 Changes Summary
| File | Type | Size | Status |
|---|---|---|---|
| README.md | Modified | 25.8 KB | ✅ Enhanced |
| QUICKSTART.md | New | 2.3 KB | ✅ Created |
| CONTRIBUTING.md | New | 5.5 KB | ✅ Created |
| TROUBLESHOOTING.md | New | 7.4 KB | ✅ Created |
| .gitignore | Modified | - | ✅ Updated |
Total Changes: 40.4 KB added, 1 file modified, 4 files created
🎯 Key Features
Documentation Structure
- Root Level: Main documentation for all users
- Subdirectories: Reference material for specific features
- Clear Navigation: Cross-references between documents
- Consistent Formatting: Unified markdown style throughout
Formatting Improvements
- Badges: Visual indicators for version, license, compatibility
- Emojis: Quick visual scanning and appeal
- Tables: Structured data presentation
- Code Blocks: Syntax highlighting for commands
- Headers: Clear hierarchy (H1-H6)
- Lists: Both ordered and unordered for clarity
- Blockquotes: Important notes and warnings
- Links: Internal and external references
User Experience
- Multiple Entry Points: Different paths for different user types
- Quick Start: 5-minute setup for impatient users
- Detailed Guides: Comprehensive information for deep dives
- Troubleshooting: Solutions for common problems
- Contributing: Clear path for contributors
- Examples: Real-world usage examples throughout
🔗 Navigation Guide
For New Users
- Start with README.md - Overview and features
- Jump to QUICKSTART.md - Get running in 5 minutes
- Refer to aliases/README.md - Available commands
For Developers
- Read CONTRIBUTING.md - Development setup
- Check TASKS.md - Roadmap and planned features
- Explore backups/VERSION_HISTORY.md - Version tracking
For Troubleshooting
- Check TROUBLESHOOTING.md - Common issues
- Review CONTRIBUTING.md - Code style and testing
- Search GitHub Issues - Community solutions
📈 Impact
Improved Discoverability
- Users can quickly find what they need
- Clear paths for different use cases
- Better search engine optimization (SEO)
Enhanced Professionalism
- Modern formatting with badges and emojis
- Comprehensive coverage of features
- Professional tone and structure
Better Onboarding
- QUICKSTART.md reduces time to first success
- Clear prerequisites and installation steps
- Essential commands clearly documented
Reduced Support Burden
- TROUBLESHOOTING.md covers common issues
- CONTRIBUTING.md clarifies development process
- Self-service resources reduce questions
🔄 Backward Compatibility
✅ Fully Backward Compatible
- All existing functionality preserved
- No breaking changes
- Configuration files unchanged
- All aliases and revsets work as before
📝 Build Artifacts
Build artifacts stored in .build-artifacts/ directory:
output.md- Original consolidated documentationsplit_docs.py- Initial extraction scriptfix_docs.py- Final extraction scriptBUILD_NOTES.md- Technical build details
These files are:
- ✅ Added to
.gitignore - ✅ Preserved for future reference
- ✅ Not included in distribution
🚀 Installation & Usage
Update Existing Installation
cd ~/.config/jjConfig
git pull origin main
make deployFresh Installation
git clone https://github.com/Thomo1318/jjConfig.git ~/.config/jjConfig
cd ~/.config/jjConfig
make deployVerify Installation
# Check documentation files exist
ls -lh README.md QUICKSTART.md CONTRIBUTING.md TROUBLESHOOTING.md
# Verify configuration
jj config list user📚 Documentation Links
- README.md - Main documentation and feature overview
- QUICKSTART.md - 5-minute setup guide
- CONTRIBUTING.md - Developer guidelines
- TROUBLESHOOTING.md - Common issues and solutions
- TASKS.md - Roadmap and future versions
- backups/VERSION_HISTORY.md - Complete version history
🙏 Credits
- Author: Thomo1318
- Documentation: Comprehensive rewrite with modern formatting
- Testing: Verified all links, formatting, and content accuracy
- Build Process: Python script-based extraction and formatting
📞 Support
- Issues: https://github.com/Thomo1318/jjConfig/issues
- Discussions: https://github.com/Thomo1318/jjConfig/discussions
- jj Community: https://discord.gg/dkmfj3aGQN
✅ Checklist
- README.md enhanced with badges and comprehensive content
- QUICKSTART.md created for new users
- CONTRIBUTING.md created for developers
- TROUBLESHOOTING.md created for common issues
- .gitignore updated with .build-artifacts/
- All links verified and working
- Markdown formatting validated
- Content accuracy checked
- Build artifacts preserved and documented
- Release notes prepared
🎉 What's Next
- v1.1.0-pager - Evaluate pager alternatives (delta, bat, diff-so-fancy)
- v2.0.0-formatters - Code formatters and linters (Ruff, Prettier, Black)
- v3.0.0-conventional - Conventional Commits integration
- v4.0.0-release-automation - Release tooling (release-please)
See TASKS.md for complete roadmap.
Thank you for using jjConfig! 🎨
...
Release Notes - v1.1.0 Documentation Update
Date: November 8, 2025
Version: v1.1.0-docs-update
Status: Ready for Release
📋 Overview
Comprehensive documentation overhaul to improve clarity, usability, and professionalism. This update introduces four new documentation files and enhances the existing README with modern formatting, badges, and comprehensive content.
✨ What's New
🆕 New Documentation Files
1. QUICKSTART.md (2.3 KB)
Purpose: Get new users up and running in 5 minutes
Contents:
- Prerequisites checklist
- 2-minute installation steps
- First repository creation guide
- Essential command reference table
- Basic workflow example
- TUI tool launchers
- Next steps and resources
Target Audience: New users, quick reference seekers
2. CONTRIBUTING.md (5.5 KB)
Purpose: Developer guidelines and contribution process
Contents:
- Development setup instructions
- Making changes guidelines (config, docs, features)
- Testing procedures (syntax validation, functional testing)
- Backup strategy and version numbering
- Pull request process with templates
- Code style guidelines (TOML, Shell, Markdown)
- Issue reporting and feature request templates
- Getting help resources
Target Audience: Contributors, developers, maintainers
3. TROUBLESHOOTING.md (7.4 KB)
Purpose: Common issues and solutions
Contents:
- Installation issues (symlink, permissions, Makefile)
- Configuration issues (loading, syntax, overrides)
- GitMCP issues (hooks, context files, URLs, failures)
- Color scheme issues (not showing, wrong colors, terminal support)
- Alias issues (not found, not working, TUI tools)
- Git integration issues (push, fetch, colocated repos)
- Performance issues (slow log, slow diff, memory usage)
- Debug logging and system info commands
- Issue reporting guidelines
Target Audience: Users experiencing problems, troubleshooters
🔄 Enhanced Documentation Files
README.md (25.8 KB)
Improvements:
- ✅ Added GitHub badges (License, Version, jj compatibility, PRs welcome)
- ✅ Added feature highlights with emojis for quick scanning
- ✅ Added comprehensive Table of Contents
- ✅ Added Prerequisites section with version requirements and optional dependencies
- ✅ Added Quick Start section linking to QUICKSTART.md
- ✅ Enhanced Installation section with step-by-step instructions
- ✅ Added comprehensive Usage section with command examples
- ✅ Added Configuration section explaining main config and reference files
- ✅ Added GitMCP Integration section with setup instructions
- ✅ Added detailed Directory Structure visualization
- ✅ Added Version History table with roadmap
- ✅ Added Contributing and Troubleshooting links
- ✅ Added Acknowledgments and Additional Resources sections
- ✅ Added footer with call-to-action
Before: 1.3 KB (basic info)
After: 25.8 KB (comprehensive guide)
📊 Changes Summary
| File | Type | Size | Status |
|---|---|---|---|
| README.md | Modified | 25.8 KB | ✅ Enhanced |
| QUICKSTART.md | New | 2.3 KB | ✅ Created |
| CONTRIBUTING.md | New | 5.5 KB | ✅ Created |
| TROUBLESHOOTING.md | New | 7.4 KB | ✅ Created |
| .gitignore | Modified | - | ✅ Updated |
Total Changes: 40.4 KB added, 1 file modified, 4 files created
🎯 Key Features
Documentation Structure
- Root Level: Main documentation for all users
- Subdirectories: Reference material for specific features
- Clear Navigation: Cross-references between documents
- Consistent Formatting: Unified markdown style throughout
Formatting Improvements
- Badges: Visual indicators for version, license, compatibility
- Emojis: Quick visual scanning and appeal
- Tables: Structured data presentation
- Code Blocks: Syntax highlighting for commands
- Headers: Clear hierarchy (H1-H6)
- Lists: Both ordered and unordered for clarity
- Blockquotes: Important notes and warnings
- Links: Internal and external references
User Experience
- Multiple Entry Points: Different paths for different user types
- Quick Start: 5-minute setup for impatient users
- Detailed Guides: Comprehensive information for deep dives
- Troubleshooting: Solutions for common problems
- Contributing: Clear path for contributors
- Examples: Real-world usage examples throughout
🔗 Navigation Guide
For New Users
- Start with README.md - Overview and features
- Jump to QUICKSTART.md - Get running in 5 minutes
- Refer to aliases/README.md - Available commands
For Developers
- Read CONTRIBUTING.md - Development setup
- Check TASKS.md - Roadmap and planned features
- Explore backups/VERSION_HISTORY.md - Version tracking
For Troubleshooting
- Check TROUBLESHOOTING.md - Common issues
- Review CONTRIBUTING.md - Code style and testing
- Search GitHub Issues - Community solutions
📈 Impact
Improved Discoverability
- Users can quickly find what they need
- Clear paths for different use cases
- Better search engine optimization (SEO)
Enhanced Professionalism
- Modern formatting with badges and emojis
- Comprehensive coverage of features
- Professional tone and structure
Better Onboarding
- QUICKSTART.md reduces time to first success
- Clear prerequisites and installation steps
- Essential commands clearly documented
Reduced Support Burden
- TROUBLESHOOTING.md covers common issues
- CONTRIBUTING.md clarifies development process
- Self-service resources reduce questions
🔄 Backward Compatibility
✅ Fully Backward Compatible
- All existing functionality preserved
- No breaking changes
- Configuration files unchanged
- All aliases and revsets work as before
📝 Build Artifacts
Build artifacts stored in .build-artifacts/ directory:
output.md- Original consolidated documentationsplit_docs.py- Initial extraction scriptfix_docs.py- Final extraction scriptBUILD_NOTES.md- Technical build details
These files are:
- ✅ Added to
.gitignore - ✅ Preserved for future reference
- ✅ Not included in distribution
🚀 Installation & Usage
Update Existing Installation
cd ~/.config/jjConfig
git pull origin main
make deployFresh Installation
git clone https://github.com/Thomo1318/jjConfig.git ~/.config/jjConfig
cd ~/.config/jjConfig
make deployVerify Installation
# Check documentation files exist
ls -lh README.md QUICKSTART.md CONTRIBUTING.md TROUBLESHOOTING.md
# Verify configuration
jj config list user📚 Documentation Links
- README.md - Main documentation and feature overview
- QUICKSTART.md - 5-minute setup guide
- CONTRIBUTING.md - Developer guidelines
- TROUBLESHOOTING.md - Common issues and solutions
- TASKS.md - Roadmap and future versions
- backups/VERSION_HISTORY.md - Complete version history
🙏 Credits
- Author: Thomo1318
- Documentation: Comprehensive rewrite with modern formatting
- Testing: Verified all links, formatting, and content accuracy
- Build Process: Python script-based extraction and formatting
📞 Support
- Issues: https://github.com/Thomo1318/jjConfig/issues
- Discussions: https://github.com/Thomo1318/jjConfig/discussions
- jj Community: https://discord.gg/dkmfj3aGQN
✅ Checklist
- README.md enhanced with badges and comprehensive content
- QUICKSTART.md created for new users
- CONTRIBUTING.md created for developers
- TROUBLESHOOTING.md created for common issues
- .gitignore updated with .build-artifacts/
- All links verified and working
- Markdown formatting validated
- Content accuracy checked
- Build artifacts preserved and documented
- Release notes prepared
🎉 What's Next
- v1.1.0-pager - Evaluate pager alternatives (delta, bat, diff-so-fancy)
- v2.0.0-formatters - Code formatters and linters (Ruff, Prettier, Black)
- v3.0.0-conventional - Conventional Commits integration
- v4.0.0-release-automation - Release tooling (release-please)
See TASKS.md for complete roadmap.
Thank you for using jjConfig! 🎨