purescript / purescript/trypurescript

Extract client code into a plugin

Open
#38 7 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PureScript
Stars
121
Forks
51
PR merge metrics
No merged PRs in 30d

Description

After some discussion with Phil about how we could improve documentation for PureScript libraries, we arrived at a design where we would like to have GitHub Pages-hosted documents easily embed runnable PureScript snippets, with something like script or pre tags, and a plugin that adds a "Run" button, posts the code to the Try PS API when the user clicks, and finally renders the output (below the snippet).

I have not had time to look into how this code is doing stuff right now, just throwing this out there. 😄

Thx!

Contributor guide

No contributing guide indexed for this repository

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

No files, tests, or entry points are named. Start by mapping the existing client code and its Try PS API integration, then clarify the plugin boundary and embedding approach. Done means GitHub Pages-hosted documents can embed runnable PureScript snippets, offer a Run button, post code to the Try PS API, and render the output below the snippet.

Written by the indexing model from the issue text.

Assessment

Domain
api, frontend, web-dev
Issue type
Feature
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.