Documentation Improvement Efforts

Discussion Topics:

  • Cookbook (repo)
    • Some libraries could use more runnable examples, but the library repo might not be the most appropriate place for these. A cookbook repo seems like a better home.
    • Discussed hosting cookbook examples on TryPureScript, but this won’t work for node.js, routing, and multiple-file examples.
  • mdbook for guides
    • Using anchors and CI ensures all code snippets are valid.
    • Similar to literate-purescript, but more flexibility in choosing snippets.
  • Type errors
    • More instruction or examples of troubleshooting type errors could be helpful.
    • The errors section of the docs repo seems like a good place to contribute these examples.
  • Language benefits could be documented more clearly for folks who are considering whether to dive in. Especially when compared to TypeScript, which offers many of the type safety wins with minimal learning curve (assuming background in JS).

Updates since last meeting:

Next Steps:

  • Showcase mdbook best practices in PS Book
    • CI tested anchored snippets
    • Collapsible imports in snippets
  • Contribute cookbook examples
2 Likes