mithril.js icon indicating copy to clipboard operation
mithril.js copied to clipboard

Update installation docs to use templates + esbuild instructions

Open kevinfiol opened this issue 3 years ago • 0 comments

Removes wordy "Step by Step" section of the installation page, as well instructions on using budo, and adds Mithril starter templates that are easy to clone. Also rewrites Quick start section to use esbuild instead of Webpack.

Description

Review the rendered markdown here.

Motivation and Context

  • Why is this change required? What problem does it solve?
    • Simplifies installation documentation
    • Moves the documentation to use newer, more up-to-date and performant tools. Webpack has a much larger dependency graph while being far less performant than esbuild, rollup, or Vite.

How Has This Been Tested?

Ran npm run build:docs locally and reviewed built documentation

Types of changes

  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [x] Documentation change

Checklist:

  • [x] My code follows the code style of this project.
  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.
  • [x] I have read the CONTRIBUTING document.
  • [ ] I have added tests to cover my changes.
  • [ ] All new and existing tests passed.
  • [ ] I have updated docs/changelog.md

kevinfiol avatar Apr 06 '23 04:04 kevinfiol