Create docs website
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.2k
- Forks
- 96
- Avg merge
- 8h 12m
- Merged PRs (30d)
- 2
Description
I would like to know if there are plans to move the documentation from README to docs.
If no one is interested I could create a PR following patterns found in: https://fonts.nuxt.com/, https://devtools.nuxt.com/, https://eslint.nuxt.com/ or https://scripts.nuxt.com/
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 reading the repository README and compare the documentation patterns in fonts.nuxt.com, devtools.nuxt.com, eslint.nuxt.com, and scripts.nuxt.com. The issue does not identify a target docs structure, files, or acceptance criteria, so confirm the planned scope before choosing an entry point; done would require an agreed documentation website replacing or complementing the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100