unjs / website

UnJS website Content and Design!
https://unjs.io
Other
124 stars 24 forks source link

Create a template for articles to provide recommendations #136

Open Barbapapazes opened 9 months ago

Barbapapazes commented 9 months ago

Environment

/

Reproduction

/

Describe the bug

The idea is to have a template with a check list in order to check things before they are published.

### Tasks
- [ ] Reviewed by package creator / maintainer
- [ ] Use `we` (or `you`) but must be consistent inside an article
- [ ] Structure template with an introduction and a conclusion
- [ ] Installation section
- [ ] Capitalize title
- [ ] Always add link arround UnJS package to their GitHub package (\[`unjs/x`\](https://github.com/unjs/x))
- [ ] Things must be simple and focused (for example: why using `unjs/jiti` when you can simply use `.mjs` file).

Additional context

No response

Logs

No response

pi0 commented 9 months ago

Nice idea overall and i love consistency across!

BTW some small things like narrative i think should be up to the writer. Something like "You can run the server locally" seems totally fine to me. We can just prepare some recommendation guidelines (just like the lint rules we have across unjs that are only advice to use)

Barbapapazes commented 9 months ago

Yes, use the template as a recommandation is totally fine for me! This reminds me that "consistency" inside a single article is important! I often see myself starting with we, then using you and finishing by we 😅