ivuorinen/gh-action-readme
1
0
Fork 0
mirror of https://github.com/ivuorinen/gh-action-readme.git synced 2026-01-26 11:14:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
gh-action-readme/docs/README.md
Ismo Vuorinen 3fbb608f9f feat: update go version, renovate config, tooling, fixes (#28) 
* feat(deps): update go version, renovate config, tooling

* chore(deps): update google/go-github to v74

* feat(deps): migrate from yaml.v3 to goccy/go-yaml

* chore(deps): update goccy/go-yaml to v1.18.0 and address security concerns

* feat: improve issue templates and project configuration

- Update GitHub issue templates with CLI-specific fields for better bug reports
- Add specialized templates for documentation, theme, and performance issues
- Update pre-commit config to include comprehensive documentation linting
- Remove outdated Snyk configuration and security references
- Update Go version from 1.23+ to 1.24+ across project
- Streamline README.md organization and improve clarity
- Update CHANGELOG.md and CLAUDE.md formatting
- Create comprehensive CONTRIBUTING.md with development guidelines
- Remove TODO.md (replaced by docs/roadmap.md)
- Move SECURITY.md to docs/security.md

* docs: fix markdown linting violations across documentation

* fix: resolve template placeholder issues and improve uses statement generation

* fix: remove trailing whitespace from GitHub issue template
2025-08-07 05:22:44 +03:00

1.2 KiB
Raw Permalink Blame History

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.