You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have to produce the Hoogle documentation as acceptance criteria.
Current State:
Currently, there is nothing in place. A promising start could be building off #12. We currently have Hoogle installed using the Haskell.nix standard approach, but that doesn't serve our scope: we can only look up a portion of the libraries we are interested in.
Scope:
This ticket focuses solely on the Nix setup. Generating documentation in a non-Nix environment is not necessary.
Definition of Done:
Start Hoogle Server with Nix: Ensure the Hoogle server can be started using Nix. Specifically, at least these symbols should be searchable in Hoogle (this set is not complete but represents some project-specific dependencies that are not present in the current hoogle setup):
pgetContinuingOutputs from plutarch-extra
plam from plutarch
ScriptContext from plutus-ledger-api
Makefile Rule: Add a Makefile target to start the Hoogle server easily.
Makefile Usage: Update the Makefile "usage" section to include instructions for starting the Hoogle server.
README Update: Update the README under the ## Tooling section to provide clear instructions on how to start and use the Hoogle server.
Useful References:
This is a Hoogle instance that behaves very similarly to what we are looking for: https://hoogle.liqwid.finance. It could be used as a reference.
The text was updated successfully, but these errors were encountered:
Start Hoogle Server
Motivation:
We have to produce the Hoogle documentation as acceptance criteria.
Current State:
Currently, there is nothing in place. A promising start could be building off #12. We currently have Hoogle installed using the Haskell.nix standard approach, but that doesn't serve our scope: we can only look up a portion of the libraries we are interested in.
Scope:
This ticket focuses solely on the Nix setup. Generating documentation in a non-Nix environment is not necessary.
Definition of Done:
pgetContinuingOutputs
fromplutarch-extra
plam
fromplutarch
ScriptContext
fromplutus-ledger-api
## Tooling
section to provide clear instructions on how to start and use the Hoogle server.Useful References:
This is a Hoogle instance that behaves very similarly to what we are looking for: https://hoogle.liqwid.finance. It could be used as a reference.
The text was updated successfully, but these errors were encountered: