purescript / purescript/spago

Add some tutorials for JS development

Open
#1,002 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

document me help wanted
Dominant language
PureScript
Stars
831
Forks
137
PR merge metrics
No merged PRs in 30d

Description

The docs used to contain some tutorials for getting a small JavaScript project up and running with various bundlers and setups.

Over time that section grew to take a considerable chunk of the docs, and it was unwieldy to maintain, so it was dropped during the rewrite of the docs.

I am not sure at all if we should include such extensive documentation for how to bootstrap a project, as it feels like it would be more suited for inclusion in the cookbook and we could just redirect there? (cc @JordanMartinez)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked legacy tutorial section and the PureScript cookbook to compare the available JavaScript setup guidance. Clarify whether Spago should restore tutorials or redirect readers elsewhere; done means the chosen documentation approach is implemented and the relevant links or tutorials are up to date.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.