metabench / metabench/jsgui3-server
Misinformation in AI generated README.md
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
It's generally well written, but some of it may be a bit aspirational rather than describing exactly what works right now. For example, there is no hot reloading feature coded into the project. Not that it would be impossible to do with the server app as it is right now though.
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.
Research direction
Start by reading README.md and compare its claims with the current project behavior, especially the statement about hot reloading. Update the README so it describes only functionality that currently works, then verify that the documented features match the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100