mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-01-26 03:04:10 +00:00
* Initial plan * Fix test token masking issue in GitHub Actions Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> * chore: update permissions, go version, linting * fix(ci): ignore test tokens for gitleaks * chore: add fetch-depth zero to all checkout actions * fix(ci): pr-lint contents write permission * [MegaLinter] Apply linters fixes * chore: ignore and remove megalinter-reports * fix: restore commitlint pre-commit hook to v9.24.0 Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ivuorinen <11024+ivuorinen@users.noreply.github.com> Co-authored-by: Ismo Vuorinen <ismo@ivuorinen.net>
Documentation
Welcome to the gh-action-readme documentation! This directory contains comprehensive guides for using and developing the tool.
📖 User Documentation
- Installation - Installation methods and package managers
- Usage - Comprehensive usage examples and CLI reference
- Configuration - Config files, environment variables, and settings
- Themes - Available themes, customization, and examples
🔧 Developer Documentation
- Development - Development setup, testing, and contribution guide
- Security - Security practices, vulnerability reporting, and policies
- API Reference - Detailed CLI command reference
🚀 Project Information
- Roadmap - Future plans and strategic initiatives
🤝 Getting Help
- Check the relevant documentation section above
- Browse the GitHub Issues
- See the main README.md for quick start information
For the latest updates and announcements, see the CHANGELOG.md.