Improve README from template note to implementation guide
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 52/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- github-actions, typescript
- Domain
- devops, documentation
Research direction
Start by comparing the README with action.yml and the repository's defined install, codegen, lint, build, bundle, and test commands. Document the action's overview, use cases, inputs, outputs, workflow example, development steps, and troubleshooting guidance; done means the examples work as-is and the documented inputs and outputs match action.yml.
Written by the indexing model from the issue text.
Description
Summary
The current README is still template-level. Expand it into an implementation-focused guide so consumers can quickly use and extend this action.
Scope
- Add a clear project overview and intended use cases.
- Document action inputs/outputs and behavior.
- Provide at least one complete workflow usage example.
- Add local development instructions (install, codegen, lint, build, bundle, test).
- Add troubleshooting notes for common setup/runtime issues.
Acceptance Criteria
- README includes quickstart and usage examples that work as-is.
- Inputs/outputs in README match action.yml.
- Development and validation commands are documented.
- Template wording is reduced in favor of actionable implementation guidance.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- Avg merge
- 1h 17m
- Merged PRs (30d)
- 59
Contributor guide
No contributing guide indexed for this repository
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.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·