input-output-hk / input-output-hk/Developer-Experience-working-group

Improving documentation for Plutus Developers

Open
#23 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
24
Forks
14
PR merge metrics
No merged PRs in 30d

Description

Currently, effective usage of Plutus in production pretty much requires reading of the Plutus specification and the extended EUTXO model. However these documents are not necessarily optimized for quick-reference in the ways a programmer may need, they're really intended for implementors and early integrations.

Additionally, a developer using Plutus will typically also make use of Haddock Generated documentation available for the Plutus Library or other related tool in Haskell.

This leaves a number of deficiencies in documentation:
- documentation should be searchable and discoverable through means that are convenient for developers (example: [MDN](https://developer.mozilla.org/en-US/)
- users of alternative languages will often need to cross-check for specific parts of the plutus API (such as scriptcontext) - perhaps something akin to internationalization can be supplied in documentation to have equivalent code examples in multiple languages

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.