Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation docs to use templates + esbuild instructions #7

Merged
merged 3 commits into from
Sep 25, 2024

Conversation

kevinfiol
Copy link
Contributor

Replaces MithrilJS/mithril.js#2827

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.

For some notes on why I went with esbuild as the "default":

  • Usage is dead simple since it's primary usage is through the CLI; no config needed to write an npm script
  • It's a small-ish static binary and is well suited for single-page applications, which Mithril embraces
  • Appeals to minimalists and folks unfamiliar with JS ecosystem. See this post
  • It will arguably be around longer than Vite (fwiw, Vite sits on top of esbuild)

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)
  • Documentation change

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • 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

Copy link
Contributor

@JAForbes JAForbes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the CI is ready to ship this, I'm very much in favour of merging this now. There's so many doc fixes here that we've wanted for a long time, if there's any further adjustments I feel we can fix them in a later PR.

Any thoughts/objections?

@dead-claudia dead-claudia merged commit 15dea75 into MithrilJS:main Sep 25, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants