Documentation Updates

I have re-structured the documentation to have a good starting point to provide a better “on-boarding”: https://twind.dev/docs/

I have splitted the documentation in to two parts:

1. Handbook: more like a tutorial and some “How To” – sourced from the docs/ folder (see docs/pages.json)
2. API: reference describing the machinery – sourced from README.md in src/ (for example src/shim/README.md)

The website is currently updated on every push to main. Later I would like to only update the website on releases to have a stable documentation for a release that is not mixed with upcoming features.

What needs to be done?

• docs/getting-started/styling-with-twind.md: use a tutorial approach – other parts of “Getting Started” may need some review to
• Empty Pages
  • docs/getting-started/quicksheet.md
  • docs/getting-started/best-practices.md
  • docs/recipes/README.md
  • docs/recipes/use-with/vue.md
  • docs/migrate-from/tailwindcss.md
  • docs/migrate-from/twin-macro.md
  • docs/faqs/README.md
  • docs/release-notes.md
• create a theme for typedoc using twind

I’m sure there is a lot more to improve. I hope that some native speakers may pick some of the tasks and provide PRs for these.

You can build the website locally using: yarn typedoc && open website/docs/index.html

/cc @tw-in-js/contributors

[just214]

I’m going to make an effort to at least start answering some of these before I submit a PR. I’m following the same format as the existing FAQ doc (detail, summary). I’ll have it submitted by tomorrow and we can regroup from there.

[sastan]

@gojutin Whoa! Great job.

If you create a PR and allow the maintainer (me) to edit the PR we can collaborate on that one. Other people can use the suggestion feature. Sounds good?