docs: rework README for the PureScript Lua set, add package nav table#2
Closed
Unisay wants to merge 1 commit into
Closed
docs: rework README for the PureScript Lua set, add package nav table#2Unisay wants to merge 1 commit into
Unisay wants to merge 1 commit into
Conversation
Replace the inherited generic package-sets README with one describing this set: the pslua backend, the upstream-ps // upstream-lua override, spago usage, and links to CONTRIBUTING.md and the ADRs. Add a navigation table of the Lua fork packages and their repo URLs. Docs only.
There was a problem hiding this comment.
Pull request overview
This PR rewrites the repository README to describe the PureScript-to-Lua (“pslua”) package set, provides spago usage guidance, and adds a navigation table linking to the Lua fork repositories.
Changes:
- Replace the upstream/generic package-sets README text with pslua-specific explanation and terminology.
- Add a “Using the set with spago” section with a concrete
packages.dhallupstream import example and tag naming guidance. - Add a “Packages” navigation table linking to Lua fork repos, plus links to CONTRIBUTING + ADRs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+12
| The set is defined in [`src/packages.dhall`](src/packages.dhall) as | ||
| `upstream-ps // upstream-lua`. The right operand wins, so the Lua forks override | ||
| their JavaScript-targeting upstreams while every other package comes straight | ||
| from the PureScript set. |
| | functions | https://github.com/Unisay/purescript-lua-functions | | ||
| | integers | https://github.com/Unisay/purescript-lua-integers | | ||
| | lazy | https://github.com/Unisay/purescript-lua-lazy | | ||
| | ngx | https://github.com/Unisay/purescript-lua-ngx | |
Comment on lines
+49
to
+52
| | refs | https://github.com/Unisay/purescript-lua-refs | | ||
| | safe-coerce | https://github.com/Unisay/purescript-lua-safe-coerce | | ||
| | strings | https://github.com/Unisay/purescript-lua-strings | | ||
| | unfoldable | https://github.com/Unisay/purescript-lua-unfoldable | |
Comment on lines
+55
to
+56
| Every other package in the set is an unmodified PureScript package that needs no | ||
| Lua-specific FFI. |
Collaborator
Author
|
Superseded by #4, which uses the post-migration org URLs and fixes the set description, the lua-ngx name, and the missing st entry. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reworks the README, which was the generic upstream
purescript/package-setspage (it even pointed psc-package users at the wrong repository).The new README describes what this set actually is: the package set for pslua, the PureScript-to-Lua backend. It explains the
upstream-ps // upstream-luaoverride, how to point spago at a released set, and links toCONTRIBUTING.mdand the ADRs.It also adds a navigation table of the Lua fork packages with their repository URLs, so the set's forks are easy to find from one place.
Docs only.