sidequestjs / sidequestjs/sidequest
Improve docs
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1k
- Forks
- 25
- Avg merge
- 12h 17m
- Merged PRs (30d)
- 5
Description
Our documentation has a lot of room for improvement.
- Add "Migrating from node-cron" section
- Create an
AGENTS.mdfile guiding LLMs on how to add Sidequest to a project - Revamp the documentation structure to improve reading flow and learning
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 reviewing the repository's existing documentation structure and the current guidance for adding Sidequest to a project. Define the documentation changes needed for the three requested items: a “Migrating from node-cron” section, an AGENTS.md file, and improved reading flow. Done means all three updates are present and the revised structure is coherent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100