Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…to effectfully/errors/preserve-operational-unlifting-errors
  • Loading branch information
effectfully committed Jun 10, 2024
2 parents d85e2ae + 8a0dacd commit 8d535f2
Show file tree
Hide file tree
Showing 97 changed files with 5,111 additions and 3,399 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/combined-haddock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# This workflow builds a combined haddock and publishes it to:
# https://intersectmbo.github.io/plutus/haddock/master
# https://intersectmbo.github.io/plutus/haddock/release/X.X.X.X
name: "Combined Haddock"
on:
workflow_dispatch:
push:
branches:
- master
- release/**
jobs:
build-and-deploy-combined-haddock:
runs-on: [self-hosted, plutus-shared]
permissions:
contents: write
environment:
name: github-pages
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Build Haddock
run: |
nix develop --accept-flake-config --command bash ./scripts/combined-haddock.sh
- name: Deploy Haddock
uses: JamesIves/github-pages-deploy-action@v4
with:
# This folder is generated in the step above
folder: combined_haddock_dst
target-folder: haddock/${{ github.ref_name }}
# combined_haddock_dst is ~400MB and keeping the entire history is unnecessary.
single-commit: true
2 changes: 1 addition & 1 deletion .github/workflows/nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ env:

jobs:
nightly-test-suite:
runs-on: [self-hosted, plutus-benchmark]
runs-on: [self-hosted, plutus-shared]
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ node.sock
.pre-commit-config.yaml
secrets/*/.gpg-id
ghcid.txt
combined_haddock*
plutus-pab/test-node/testnet/db
plutus-pab/test-node/alonzo-purple/db
*.actual.json
Expand Down
13 changes: 0 additions & 13 deletions docusaurus/docs/essential-concepts/plutus-platform.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,19 +83,6 @@ Furthermore, while none of these are quite as security-critical as the trusted k

Even simple applications must deal with this complexity, and for more advanced applications that deal with state across time, the difficulty is magnified.

## Why we call it a platform

This is why the Plutus Platform is a *platform*.
Rather than just providing a few tools to make the bare minimum possible, we aim to support application development in its entirety, all the way through from authoring to testing, runtime support, and (eventually) verification.

Conceptually, the Platform breaks down based on which part of the system we're interested in:

- [Plutus Foundation](plutus-foundation.md): support for writing the trusted kernel of code, and executing it on the chain
- [The Plutus Application Framework](https://github.com/IntersectMBO/plutus-apps): support for writing applications ("Plutus Applications") in a particular style

![A high-level architecture of the Plutus Platform, with an emphasis on applications](../../static/img/platform-architecture.png)
*A high-level architecture of the Plutus Platform, with an emphasis on applications*

## Additional resources

- Michael Peyton-Jones and Jann Mueller introduce the Plutus platform in [this session](https://youtu.be/usMPt8KpBeI?si=4zkS3J7Bq8aFxWbU) from the Cardano 2020 event.
Expand Down
13 changes: 8 additions & 5 deletions docusaurus/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ All of these elements are used in combination to write Plutus Core scripts that

To develop and deploy a smart contract, you also need off-chain code for building transactions, submitting transactions, deploying smart contracts, querying for available UTXOs on the chain, and so on. You may also want a front-end interface for your smart contract for a better user experience.

Plutus allows all programming to be done from a single Haskell library. This lets developers build secure applications, forge new assets, and create smart contracts in a predictable, deterministic environment with the highest level of assurance. Furthemore, developers don’t have to run a full Cardano node to test their work.
Plutus allows all programming to be done from a [single Haskell library](https://intersectmbo.github.io/plutus/master/). This lets developers build secure applications, forge new assets, and create smart contracts in a predictable, deterministic environment with the highest level of assurance. Furthemore, developers don’t have to run a full Cardano node to test their work.

With Plutus you can:

- Forge new tokens in a lightweight environment
- Build smart contracts
- Forge new tokens in a lightweight environment,
- Build smart contracts, and
- Support basic multi-sig scripts.

## Getting started with Plutus Tx
Expand All @@ -41,8 +41,11 @@ See, for example:

## The Plutus repository

The [Plutus repository](https://github.com/IntersectMBO/plutus) contains the implementation, specification, and mechanized metatheory of Plutus Core.
It also contains the Plutus Tx compiler and the libraries, such as `PlutusTx.List`, for writing Haskell code that can be compiled to Plutus Core.
The [Plutus repository](https://github.com/IntersectMBO/plutus) includes:

* the implementation, specification, and mechanized metatheory of Plutus Core
* the Plutus Tx compiler
* the combined documentation, generated using Haddock, for all the [public Plutus code libraries](https://intersectmbo.github.io/plutus/master/), such as `PlutusTx.List`, enabling developers to write Haskell code that can be compiled to Plutus Core.

## Educational resources

Expand Down
Loading

0 comments on commit 8d535f2

Please sign in to comment.