mirror of
https://github.com/ivuorinen/gh-action-readme.git
synced 2026-02-04 22:45:05 +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
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
---
|
|
name: Documentation quality issue
|
|
about: Report problems with generated documentation output
|
|
title: '[DOCS] '
|
|
labels: documentation, quality
|
|
assignees: ivuorinen
|
|
|
|
---
|
|
|
|
**Describe the documentation issue**
|
|
A clear description of what's wrong with the generated documentation.
|
|
|
|
## Theme and format used
|
|
|
|
- Theme: [github, gitlab, minimal, professional, default]
|
|
- Output format: [md, html, json, asciidoc]
|
|
- Command used: `gh-action-readme gen [your flags here]`
|
|
|
|
**Sample action.yml**
|
|
The action.yml input that produces the problematic documentation:
|
|
|
|
```yaml
|
|
# Paste your action.yml content here
|
|
```
|
|
|
|
**Current generated output**
|
|
The problematic documentation that was generated:
|
|
|
|
```markdown
|
|
# Paste the current output here (or relevant excerpt)
|
|
```
|
|
|
|
**Expected documentation**
|
|
What the documentation should look like instead:
|
|
|
|
```markdown
|
|
# Paste what you expected here
|
|
```
|
|
|
|
**Issue category**
|
|
What type of documentation problem is this?
|
|
|
|
- [ ] Missing information (inputs, outputs, etc.)
|
|
- [ ] Incorrect formatting/rendering
|
|
- [ ] Broken links or references
|
|
- [ ] Poor table layout
|
|
- [ ] Badge/shield issues
|
|
- [ ] Code block formatting
|
|
- [ ] Template logic error
|
|
- [ ] Theme-specific styling problem
|
|
- [ ] Other: ___________
|
|
|
|
## Environment information
|
|
|
|
- OS: [e.g. macOS 14.1, Ubuntu 22.04, Windows 11]
|
|
- gh-action-readme version: [run `gh-action-readme version`]
|
|
|
|
**Additional context**
|
|
Add any other context about the documentation quality issue. Include:
|
|
|
|
- Screenshots if it's a visual formatting problem
|
|
- Links to similar actions with good documentation
|
|
- Specific markdown/HTML sections that are problematic
|