Skip to content

Commit 2b658d6

Browse files
committed
testing new domain
1 parent b5a28d4 commit 2b658d6

File tree

10 files changed

+95
-30
lines changed

10 files changed

+95
-30
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# MkDocs build output
22
site/
3+
.cache/
34

45
# Python
56
__pycache__/

docs/documentation/jets-explained.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The development of a Jet follows a **rigorous, multi-stage pipeline** to ensure
2929
---
3030

3131
### 1. Prototyping with Simplicity Combinators
32+
3233
The initial phase involves building the desired functionality using only the fundamental building blocks (combinators) of Simplicity.
3334

3435
This serves as a high-level, human-readable blueprint.
@@ -68,5 +69,5 @@ This proves that the optimized C implementation is semantically identical to the
6869
Once fully verified and benchmarked, the Jet is integrated into the **core Simplicity library** and considered for standardization, making it available for general use in Liquid and Bitcoin scripts.
6970

7071
### 8. Deployment
71-
Newer Jets are deployed to a Bitcoin **testnet** for real-world testing.
7272

73+
Newer Jets are deployed to a Bitcoin **testnet** for real-world testing.

docs/documentation/simplicity-compared.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
21
Simplicity was designed from the ground up to address the limitations of existing blockchain scripting languages while maintaining the security guarantees that make Bitcoin reliable.
32

4-
53
| | **Bitcoin Script** | **Miniscript** | **Solidity** | **Simplicity** | **Comments** |
64
|---|---|---|---|---|---|
75
| **Primary purpose** | Minimal spend conditions for Bitcoin UTXOs | Safer, structured way to write Bitcoin Script policies | General-purpose smart contracts on Ethereum-like blockchains | Formally verifiable contracts in Bitcoin-like settings | |
@@ -13,4 +11,4 @@ Simplicity was designed from the ground up to address the limitations of existin
1311
| **State model** | UTXO (local) | UTXO (via Script) | Account/global state | UTXO-style | Local (UTXO) limits blast radius; global state enables composability but can spread risk. |
1412
| **Formal verification** | Limited | Better static analysis | Possible but complex | Core feature | Strong guarantees lower the chance of catastrophic bugs and costly exploits. |
1513
| **Performance/resource bounds** | Bounded by consensus | Bounded by consensus | Gas-limited execution | Strict bounds | Predictable costs and low DoS risk make fees and UX more stable. |
16-
| **Interoperability** | Bitcoin-native | Bitcoin-native | EVM-wide standards | Liquid ecosystem | Affects integrations and network effects for adoption. |
14+
| **Interoperability** | Bitcoin-native | Bitcoin-native | EVM-wide standards | Liquid ecosystem | Affects integrations and network effects for adoption. |

docs/index.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
title: "A typed functional smart contract language for bitcoin-like blockchains."
3-
description: "A typed, combinator-based, functional smart contract language without loops or recursion, designed for Bitcoin-like blockchains."
42
hide:
53
- navigation
64
- toc
75
- title
86
---
97

10-
Simplicity is a typed, combinator-based, functional smart contract language without loops or recursion, designed for Bitcoin-like blockchains.
8+
# A typed, combinator-based, functional smart contract language without loops or recursion, designed for Bitcoin-like blockchains."
119

1210
## Key Features
1311

docs/resources/faq.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
1+
# Simplicity FAQ
12

2-
### Simplicity is so simple it fits on a [T-shirt](https://store.blockstream.com/products/simplicity-t-shirt). Does that mean it's as limited as Bitcoin Script?
3+
## Simplicity is so simple it fits on a [T-shirt](https://store.blockstream.com/products/simplicity-t-shirt). Does that mean it's as limited as Bitcoin Script?
34

45
No, the "simplicity" refers to its foundational design and formal semantics, not its expressiveness.
56

67
- Bitcoin Script is deliberately limited; Simplicity is finitarily complete → it can program any finite computation.
78

89
- Complex off-chain (even Turing-complete) computations can be verified on-chain with Simplicity.
910

10-
### Is Simplicity Turing-complete like EVM?
11+
## Is Simplicity Turing-complete like EVM?
1112

1213
No, and that’s a feature!
1314

@@ -17,7 +18,7 @@ No, and that’s a feature!
1718

1819
- **Enhanced Verifiability:** Programs are analyzable, enabling formal reasoning.
1920

20-
### How does Simplicity handle state? Does it have global state like Ethereum?
21+
## How does Simplicity handle state? Does it have global state like Ethereum?
2122

2223
Simplicity has no global state. It is a purely functional language: each program is just a function mapping inputs → outputs.
2324

@@ -31,7 +32,7 @@ Contracts run within the Bitcoin UTXO model:
3132

3233
This design avoids shared mutable state (as in Ethereum). Instead, every transition is localized: a UTXO is consumed, and the updated state is re-committed into the new UTXO.
3334

34-
### How do I prove my Simplicity contract is correct?
35+
## How do I prove my Simplicity contract is correct?
3536

3637
Formal verification happens in [Coq/Rocq](https://rocq-prover.org/), not directly in Simplicity.
3738

@@ -43,7 +44,7 @@ Process:
4344

4445
3. Proofs give guarantees before deployment.
4546

46-
### Simplicity is low-level. Do I write contracts directly in it?
47+
## Simplicity is low-level. Do I write contracts directly in it?
4748

4849
Not usually. There are higher-level options:
4950

@@ -55,23 +56,23 @@ Not usually. There are higher-level options:
5556

5657
The future vision is that there are multiple high-level languages which all compile down to Simplicity + proofs.
5758

58-
### What are Jets, and how do they make programs efficient?
59+
## What are Jets, and how do they make programs efficient?
5960

60-
A [Simplicity jet](documentation/jets-explained.md) is a pre-defined, optimized function that replaces an equivalent Simplicity expression to speed up execution without changing its meaning.
61+
A [Simplicity jet](../documentation/jets-explained.md) is a pre-defined, optimized function that replaces an equivalent Simplicity expression to speed up execution without changing its meaning.
6162

6263
Benefits:
6364

64-
- Programs remain formally verifiable.
65+
- Programs remain formally verifiable.
6566

66-
- Heavy operations run in optimized C instead of interpreted combinators.
67+
- Heavy operations run in optimized C instead of interpreted combinators.
6768

68-
- Keeps execution fast, compact, and analyzable.
69+
- Keeps execution fast, compact, and analyzable.
6970

70-
### How does Simplicity exist alongside Bitcoin script?
71+
## How does Simplicity exist alongside Bitcoin script?
7172

7273
With Taproot’s versioned leaves, a single Taproot output can include both standard Script/Miniscript leaves and a Simplicity leaf. This allows mixing policies: simple paths can remain in Script while advanced paths use Simplicity, preserving flexibility and privacy under one Taptree.
7374

74-
### How do I track the value of a Simplicity contract with partial payouts when different strike prices are being matched?
75+
## How do I track the value of a Simplicity contract with partial payouts when different strike prices are being matched?
7576

7677
Simplicity contracts operate on UTXO-committed state. Each contract output carries forward a table of strikes together with their remaining notionals.
7778

docs/resources/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The primary objective for the current development cycle is to prepare Simplicity for execution on a Bitcoin test network. Achieving this objective requires finalising the set of jets, establishing a complete cost model, and implementing state storage for advanced contract functionality.
44

5-
### Bitcoin Integration
5+
### Bitcoin Testnet Integration
66

77
Work will continue towards producing a signet-mergeable integration branch of bitcoin-core containing Simplicity. Key tasks include:
88

docs/stylesheets/extra.css

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,54 @@
55

66
.md-source {
77
display: none !important;
8+
}
9+
10+
/* Hero section styles */
11+
.hero {
12+
background-color: var(--md-primary-fg-color);
13+
color: var(--md-primary-bg-color);
14+
padding: 4rem 1rem;
15+
text-align: center;
16+
}
17+
18+
.hero h1 {
19+
font-size: 3rem;
20+
font-weight: 700;
21+
margin-bottom: 1rem;
22+
}
23+
24+
.hero p {
25+
font-size: 1.2rem;
26+
max-width: 600px;
27+
margin: 0 auto 2rem;
28+
}
29+
30+
.hero .md-button {
31+
margin: 0 0.5rem;
32+
}
33+
34+
/* Quote section styles */
35+
.quotes {
36+
display: grid;
37+
gap: 1rem;
38+
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
39+
margin-top: 2rem;
40+
}
41+
42+
.quote-card {
43+
border-left: 4px solid var(--md-primary-fg-color);
44+
padding: 1rem;
45+
background-color: var(--md-code-bg-color);
46+
border-radius: 4px;
47+
}
48+
49+
.quote-card blockquote {
50+
margin: 0;
51+
font-style: italic;
52+
}
53+
54+
.quote-card footer {
55+
margin-top: 1rem;
56+
font-weight: bold;
57+
text-align: right;
858
}

mkdocs.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
site_name: Simplicity
2-
site_url: https://new-docs.simplicity-lang.org
2+
site_url: https://docs.simplicity-lang.org
3+
site_description: A typed, functional smart contract language for Bitcoin-like blockchains. # Add this line
34
plugins:
5+
- search:
46
- git-revision-date-localized:
57
- git-committers:
68
repository: BlockstreamResearch/simplicity-docs
79
branch: main
810
theme:
911
name: material
12+
custom_dir: overrides
1013
favicon: assets/logo-symbol.svg
1114
logo: assets/logo-symbol.svg
1215
features:
@@ -27,7 +30,6 @@ theme:
2730
- search.share
2831
- search.suggest
2932
- toc.follow
30-
# - toc.integrate
3133
palette:
3234
# Palette toggle for automatic mode
3335
- media: "(prefers-color-scheme)"
@@ -75,10 +77,8 @@ markdown_extensions:
7577
- pymdownx.details:
7678
- pymdownx.tabbed:
7779
alternate_style: true
78-
7980
extra_css:
8081
- stylesheets/extra.css
81-
8282
extra:
8383
generator: false
8484
social:
@@ -88,7 +88,6 @@ extra:
8888
link: https://t.me/simplicity_lang
8989
- icon: fontawesome/brands/github
9090
link: https://github.com/BlockstreamResearch/simplicity
91-
# rust link
9291
- icon: fontawesome/brands/rust
9392
link: https://crates.io/crates/simplicity
9493
analytics:
@@ -125,9 +124,9 @@ nav:
125124
- Haskell: getting-started/haskell.md
126125
- Documentation:
127126
- documentation/index.md
127+
- How Simplicity Works: documentation/how-simplicity-works.md
128128
- Jets Explained: documentation/jets-explained.md
129129
- Simplicity for EVM developers: documentation/simplicity-for-evm-developers.md
130-
- How Simplicity Works: documentation/how-simplicity-works.md
131130
- Simplicity Compared: documentation/simplicity-compared.md
132131
- SimplicityHL Reference:
133132
- simplicityhl-reference/index.md

netlify.toml

Lines changed: 0 additions & 4 deletions
This file was deleted.

overrides/main.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{% extends "base.html" %}
2+
3+
{% block content %}
4+
{% if page.is_homepage %}
5+
<section class="hero">
6+
<div class="hero-text">
7+
<h1>{{ config.site_name }}</h1>
8+
<p>{{ config.site_description }}</p>
9+
<a href="{{ 'getting-started/' | url }}" class="md-button md-button--primary">
10+
Get Started
11+
</a>
12+
<a href="{{ 'documentation/' | url }}" class="md-button">
13+
Read the Docs
14+
</a>
15+
</div>
16+
</section>
17+
{% endif %}
18+
19+
{# Render the page content #}
20+
{{ super() }}
21+
{% endblock %}

0 commit comments

Comments
 (0)