Streamlines the README by removing redundant sections for specific audiences and enhancing the contribution guidelines.
Improves the discoverability of contribution information.
Also, links the citation badge to the citation section.
Refines the README to provide more comprehensive instructions and examples for using the Book Binder CLI.
This includes:
- Updates download links for PDF and EPUB formats.
- Improves clarity of command descriptions.
- Adds new commands and options to the CLI documentation, reflecting recent enhancements.
- Clarifies the development workflow and publishing process.
These changes aim to improve the user experience and make the book easier to build and contribute to.
Miscellaneous updates:
- Regenerated quiz.json files for consistency
- Updated README.md with IEEE CODES+ ISSS 2024 citation badge
- Updated publishing documentation in README
- Commented out frontmatter sections in PDF config for faster builds
- Minor formatting consistency across .qmd files
These changes improve documentation accuracy and build performance.
- Add contributors section before 'Made with ❤️' section
- Include proper ALL-CONTRIBUTORS markers for automated updates
- Contributors will now appear in both README.md and acknowledgements.qmd
- Should include taunoe and all other contributors automatically
📚 Documentation Updates:
- Updated README.md with current binder commands
- Removed references to hello command (replaced with doctor)
- Updated CLI README.md to remove binder_legacy references
- Updated BINDER.md with current command set and shortcuts
- Removed check/check-tags from all documentation
- Updated doctor.py to only check for binder executable
🎯 Key Changes:
- All docs now reference current binder commands only
- Consistent command examples throughout documentation
- Updated shortcuts to match current CLI aliases
- Removed legacy command references
- Focus on build-centric workflow as intended
✅ Documentation Consistency:
- README.md: Updated quick start and development sections
- cli/README.md: Removed legacy references
- docs/BINDER.md: Updated command tables and examples
- All examples use current binder command structure
- Update project structure to reflect quarto/ directory (was book/)
- Simplify binder command examples to match new CLI interface
- Add EPUB build support in documentation and examples
- Update setup instructions to use './binder setup' as primary method
- Reorganize project structure section for better clarity
- Remove outdated Make command references in favor of binder CLI
- Update file paths and directory structure to match current layout
This brings the README in sync with the current project structure and tooling.
- Update BINDER.md with publish command and about command
- Update DEVELOPMENT.md with new build workflow
- Update tools/scripts/README.md to reference binder
- Update main README.md with publishing section
- Remove EPUB from GitHub workflow valid formats and build steps
- Remove EPUB config references from binder script
- Remove EPUB rendering and compression functions from publish script
- Remove EPUB file patterns from .gitignore
- Update README.md to remove EPUB config reference
- Update help messages to only mention HTML and PDF formats
- Tested binder commands and status functionality
Enhances project organization by restructuring directories for improved maintainability and clarity.
- Introduces dedicated directories for scripts, configurations, and local development files.
- Clarifies the purpose of existing directories by grouping related files together.
✅ Improved binder command clarity and usability
• Build commands now require explicit format: 'binder build * html' or 'binder build intro pdf'
• Removes ambiguity between HTML/PDF builds - no more defaults
• Uses '*' for building all chapters, making intent clear
• Updated all documentation (README.md, BINDER.md) with new syntax examples
• Maintains backward compatibility by keeping build-full command internally
• Enhanced help text with clear usage examples and error messages
This change makes the CLI more explicit and reduces user confusion about output formats.
Added BINDER.md with complete CLI documentation including:
- Quick start guide and installation instructions
- Comprehensive command reference with examples
- Advanced features (unified builds, fast build mode)
- Development workflow and troubleshooting guide
- Integration details and performance tips
Updated README.md to highlight binder as recommended development tool:
- Added binder CLI section with key commands
- Updated project structure to show binder and config files
- Fixed documentation links to point to docs/ directory
Cleaned up duplicate documentation:
- Removed root-level BUILD.md, CODE_OF_CONDUCT.md, DEVELOPMENT.md,
MAINTENANCE_GUIDE.md, contribute.md (kept updated versions in docs/)
- Consolidated all documentation in docs/ directory
- Updated all references to use docs/ path
This streamlines the development experience and reduces confusion
about which documentation files are current.
- Update project structure to include new build/ directory
- Remove emojis from project structure section as requested
- Keep build directory documentation clean and professional
- Maintain consistency with project organization
- Fixed path issues in .all-contributorsrc and update_contributors.py
- Added contributors section to README with all-contributors markers
- Positioned contributors section towards the end of README as requested
- Ensured automated updates will work for both acknowledgements and README
- Reorganize README for visitor-first experience
- Add Harvard branding and dynamic GitHub badges
- Improve GitHub star call-to-action messaging
- Fix book cover display and text wrapping on index page
- Update gitignore for build artifacts
- Enhance responsive design for mobile devices
