Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Simplify "Setup" (Quick-Start Seed) #3492

Open
@ghost

Description

Please switch context.

Jump into the skin of a newcomer, who happily comes to the website to check out this new thing called Angular2.

See, you even suggest this: "A suggested path through the documentation for Angular newcomers."

The newcomer quickly gets in contact with this one here:

https://angular.io/docs/ts/latest/guide/setup.html

And gets bombarded with information, tech-jargon, fancy names, and strange looking cmd-lines like:

for /f %i in (non-essential-files.txt) do del %i /F /S /Q

This content is far far too much, and should be dramatically simplified, thus a newcomer does not get shocked right with his first steps with Angular2.

Additionally, the "teacher-tenor" should be avoided ("now we learn" etc.).

Expected:

  • Very clear intro-lines, without much explanation about the documentation itself (good docs are self-explaining, bad docs need to explain themselves).

  • Really super-simple quick-start, ideally based on the cli-tool (which a user assumes as a natural part of the product "angular2").

But as first step, it would be enough to reduce this "setup" thing to a minimum (and move the Appendix sections where they belong: within separate documents, appended to the main docu).

(I can provide a sample of what I'm talking about)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions