Docs: sub-action READMEs still reference v5 instead of v6
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.6k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
Problem
The main README.md was updated for v6, but the sub-action READMEs still contain @v5 references in their code examples:
save/README.md— 6 occurrences of@v5restore/README.md— 4 occurrences of@v5
Additionally, the main README.md has:
- 2 remaining
@v5references (lines 21 and 86) - An obsolete "Important changes" block discussing a February 1st, 2025 deadline that has already passed
Proposed Fix
I have a ready fix on my fork: docs/update-v5-to-v6-references
Changes:
- Update all
@v5references to@v6inREADME.md,save/README.md,restore/README.md - Rewrite the outdated "Important changes" block to past tense
- Remove unused
[style]link reference inCONTRIBUTING.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching for @v5 in README.md, save/README.md, and restore/README.md, then inspect the outdated “Important changes” block in README.md. Check CONTRIBUTING.md for the unused [style] reference. Done means the named documentation uses @v6, the obsolete block is rewritten for the current state, and the unused link reference is removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100