mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-01 05:43:29 +00:00
Ismo Vuorinen
3fbb608f9f
* 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
31 lines
1.2 KiB
Markdown
31 lines
1.2 KiB
Markdown
# Documentation
|
|
|
|
Welcome to the gh-action-readme documentation! This directory contains comprehensive guides for using and developing the tool.
|
|
|
|
## 📖 User Documentation
|
|
|
|
- **[Installation](installation.md)** - Installation methods and package managers
|
|
- **[Usage](usage.md)** - Comprehensive usage examples and CLI reference
|
|
- **[Configuration](configuration.md)** - Config files, environment variables, and settings
|
|
- **[Themes](themes.md)** - Available themes, customization, and examples
|
|
|
|
## 🔧 Developer Documentation
|
|
|
|
- **[Development](development.md)** - Development setup, testing, and contribution guide
|
|
- **[Security](security.md)** - Security practices, vulnerability reporting, and policies
|
|
- **[API Reference](api.md)** - Detailed CLI command reference
|
|
|
|
## 🚀 Project Information
|
|
|
|
- **[Roadmap](roadmap.md)** - Future plans and strategic initiatives
|
|
|
|
## 🤝 Getting Help
|
|
|
|
- Check the relevant documentation section above
|
|
- Browse the [GitHub Issues](https://github.com/ivuorinen/gh-action-readme/issues)
|
|
- See the main [README.md](../README.md) for quick start information
|
|
|
|
---
|
|
|
|
For the latest updates and announcements, see the [CHANGELOG.md](../CHANGELOG.md).
|