Skip to content

Commit 798f761

Browse files
committed
More docs, tutorial and blog updates
1 parent 8299b8c commit 798f761

13 files changed

+89
-20
lines changed

blog/2024-09-16-new-doc-site.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
slug: first-blog-post
3-
title: Welcome to the new Convex Docs site!
3+
title: New Convex Docs site!
44
authors: [mikera]
55
tags: [welcome, convex, community]
66
---
77

88
After a few days of hacking we've finally got our new documentation site up and running! Every great project needs great docs, and we're using a powerful tool to make this happen: [Docusaurus](https://docusaurus.io/)
9+
<!-- truncate -->
910

1011
What's great about this?
1112
- Everyone in the community can now easily [contribute documentation](https://github.com/Convex-Dev/design) though the GitHub `design` repository

blog/2024-09-16-welcome/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ tags: [convex, welcome, community]
88
Welcome to the Convex Developer Documentation! The is the go-to resource for building with Convex.
99

1010
We're thrilled to introduce our new developer documentation site. This platform is designed to be your comprehensive guide for mastering Convex, a powerful decentralised platform based on lattice technology.
11+
<!-- truncate -->
1112

1213
What you'll find here:
1314

blog/authors.yml

+9
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,12 @@ convex:
1919
x: convex_world
2020
github: Convex-Dev
2121

22+
helins:
23+
name: Adam Helinski
24+
title: Core Contributor
25+
url: https://github.com/helins
26+
image_url: https://github.com/helins.png
27+
page: true
28+
socials:
29+
github: helins
30+

docs/overview/concepts.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Key Concepts
3+
authors: [convex]
4+
tags: [convex]
5+
---
6+
7+
# Convex Concepts
8+
9+
## Overview
10+
11+
Convex is a decentralised platform for the Internet of Value, offering flexibility and scalability far beyond the capabilities of traditional blockchains. In particular, it is designed to support high volume, interactive applications used directly by end users such as for mobile apps, payments and gaming.
12+
13+
14+
## Governance
15+
16+
Convex is governed by the non-profit Convex Foundation. The Foundation performs the following activities:
17+
18+
- Ensures good governance of the Convex Network
19+
- Operates key resources on behalf of the community, including the https://convex.world website and developer resources such as GitHub repositories
20+
- Acts as this initial issuer of Convex Coins to individuals and organisations, inlciding management of the release curve
21+
- Provides awards for contributors to Convex (e.g. open source developers)
22+
- Supports the development of the Convex ecosystem via partnerships, marketing, education and other initiatives

papers/convex-whitepaper.md renamed to docs/overview/convex-whitepaper.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: White Paper
3+
authors: [convex]
4+
tags: [convex, technology]
5+
---
16
# Convex White Paper
27

38
## Abstract

papers/manifesto.md renamed to docs/overview/manifesto.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Manifesto
3+
authors: [convex]
4+
tags: [convex, community, philosophy]
5+
---
6+
17
# The Convex Manifesto - DRAFT
28

39
We are building open economic systems based on decentralised technology for the 21st century and beyond.

docs/tutorial/convex-lisp/index.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
slug: convex-lisp
3+
title: Convex Lisp
4+
authors: [mikera]
5+
tags: [convex, developer, lisp]
6+
---
7+
8+
Convex Lisp is a powerful modern Lisp for decentralised systems.
9+
10+
## Why Lisp?
11+
12+
The CVM is designed to be able to support many different languages and paradigms. However, we wanted a powerful language that would empower developers on Convex from the beginning, and chose Lisp for a number of reasons.
13+
14+
- **Immutability**: Lisp's functional programming paradigm promotes immutability, which is essential for ensuring the integrity and consistency of decentralised systems where data must be replicated and distributed across multiple nodes.
15+
- **Dynamic typing**: Lisp's dynamic typing allows for flexible data structures and easy modifications, crucial for adapting to the constantly evolving nature of decentralised systems. At the same time, Convex Lisp is **strongly typed**, avoiding the issues associated with weak typing.
16+
- **Code is data**: representing code using its own data structures (also known as "homoiconicity") gives Lisp advanced **metaprogramming** capabilities the creation of domain-specific languages (DSLs) tailored to specific concepts, making it easier to reason about and implement complex economic mechanisms.
17+
- **Interactive coding**: Lisp pineered the use of the REPL for highly interactive programming. With Convex, we've taken this a step further with a complete on-chain compiler so that everything on the CVM can be done with simple interactive Lisp commands.
18+
19+
Convex Lisp was heavily inspired by [Clojure](https://clojure.org/), from which it borrows most basic and many core functions, and [Racket Scheme](https://racket-lang.org/) which inspired many of the more advanced metaprograming facilities.
20+
21+
## Some technical notes on Convex Lisp
22+
23+
- Convex Lisp is a **Lisp-1** (i.e. keeps function and data values in the same namespace).This is simpler than a Lisp-2 and seems more appropriate for a functional programming language, where functions are regularly treated as first class values.

docs/tutorial/lisp-guide-advanced.md renamed to docs/tutorial/convex-lisp/lisp-guide-advanced.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
slug: convex-lisp
3+
title: Advanced Guide
4+
authors: [mikera, helins]
5+
tags: [convex, developer, lisp]
6+
---
7+
18
If you've got this far, you may be interested in some of the more advanced features of Convex Lisp. This section is intended for people who want to know more about how Convex Lisp work, and how it integrated with the capabilities of the CVM.
29

310
## Compiler Phases
File renamed without changes.

papers/glossary.md renamed to docs/tutorial/glossary.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Glossary
3+
authors: [convex]
4+
tags: [convex, community, tutorial]
5+
---
6+
17
## Account
28

39
An Account is a record of identification and ownership within Convex. Accounts may be either:

docusaurus.config.ts

+6
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ const config: Config = {
7575
src: 'img/Convex.png',
7676
},
7777
items: [
78+
{
79+
type: 'docSidebar',
80+
sidebarId: 'overviewSidebar',
81+
position: 'left',
82+
label: 'Overview',
83+
},
7884
{
7985
type: 'docSidebar',
8086
sidebarId: 'tutorialSidebar',

papers/concepts.md

-19
This file was deleted.

sidebars.ts

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
1212
*/
1313
const sidebars: SidebarsConfig = {
1414
// By default, Docusaurus generates a sidebar from the docs folder structure
15+
overviewSidebar: [{type: 'autogenerated', dirName: 'overview'}],
16+
1517
tutorialSidebar: [{type: 'autogenerated', dirName: 'tutorial'}],
1618

1719
cadsSidebar: [{type: 'autogenerated', dirName: 'cad'}],

0 commit comments

Comments
 (0)