aurelia / aurelia/documentation

Recommendation: Build Systems parent page that summarizes and helps people choose one

Open
#258 4 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
104
Forks
108
PR merge metrics
No merged PRs in 30d

Description

I think it would be helpful to add a parent page to Build Systems that:
1. Summarizes each option (CLI, Webpack, JSPM) and maybe give benefits/drawbacks of each one
2. Helps people new to Aurelia and build systems choose
3. Specifies if there's an Aurelia "standard", like the CLI, that someone should choose if they don't know what to choose

I'm new to Aurelia and build systems and want to start an Aurelia app but don't know which build system to choose. I read in a blog post comment that Webpack is favored over JSPM. If that's still true things like that would be good to mention on the new summary page. Also it may be good to mention if the CLI is ready for prime time but has known limitations.

Congrats team on 1.0 release!

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing Build Systems documentation and the current CLI, Webpack, and JSPM pages. Compare what each option currently supports and document the trade-offs and recommended default; done means newcomers can choose a build system from one parent page.

Written by the indexing model from the issue text.

Assessment

Tech stack
webpack
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.