feat: site with mdbook (#170)

* feat: init mdbook minimially destructive for repo structure * feat: move assets, and wgs into cips dir * fix: linting * fix: linting * feat: note about mdbook * feat: edit wgs overview bc links are fkd * feat: add plausible script for celestia * feat: add back links * fix: rm links bc broke * feat: test frontmatter as codeblock * feat: surround frontmatter with backticks and edit CIP-1 * fix: conflicts fix: linting fix: resolve conflicts fix: add cip: 23 to frontmatter fix: conflicts * feat: demo different frontmatter style * feat: use GFM tables option 3 * feat: standardize requires CIP-n * fix: linting * fix: ignore bare url * fix: cip-15 * fix: full links for forum * fix: rm repo-wide bypass of MD025 * feat: add install clarification * Apply suggestions from code review Co-authored-by: Rootul P <[email protected]> * feat: use option 2 * fix: linting on cip-15 * fix: remove unused linting bypass * fix: add used rule --------- Co-authored-by: Rootul P <[email protected]>
celestiaorg · Jul 19, 2024 · 49b0adc · 49b0adc
1 parent eb27c94
commit 49b0adc
Show file tree

Hide file tree

Showing 42 changed files with 461 additions and 338 deletions.
diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml
@@ -0,0 +1,56 @@
+name: Deploy mdBook site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MDBOOK_VERSION: 0.4.40
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with mdBook
+        run: mdbook build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./book
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,8 @@
+book
+index.html
+
+# CIPs - not sure if this is necessary anymore. on a fresh clone and build, the cips folder is empty of .html
+cips/*.html
+
+# WGs - same note as above
+cips/wgs/**/*.html
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -3,3 +3,4 @@
   "code_blocks": false # Disable rule for hard tabs in code blocks
 "MD013": false # Disable rule for line length
 "MD033": false # Disable rule banning inline HTML
+"MD041": false # Disable rule for first line in file
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Celestia Improvement Proposal (CIP) process
 
-Read [CIP-1](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-1.md) for information on the CIP process.
+Read [CIP-1](./cip-1.md) for information on the CIP process.
 
 ## Meetings
 
@@ -23,29 +23,29 @@ Read [CIP-1](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-1.md) for in
 
 |           №           |                                    Title                                     |                                                                       Author(s)                                                                        |
 |:---------------------:|:----------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|
-|  [1](/cips/cip-1.md)  |             Celestia Improvement Proposal Process and Guidelines             |                                                             Yaz Khoury <[email protected]>                                                              |
-|  [2](/cips/cip-2.md)  |                             CIP Editor Handbook                              |                                                                 Yaz Khoury (@YazzyYaz)                                                                 |
-|  [3](/cips/cip-3.md)  |                   Process for Approving External Resources                   |                                                                 Yaz Khoury (@YazzyYaz)                                                                 |
-|  [4](/cips/cip-4.md)  |                Standardize data expiry time for pruned nodes                 |                                      Mustafa Al-Bassam (@musalbas), Rene Lubov (@renaynay), Ramin Keene (@ramin)                                       |
-|  [5](/cips/cip-5.md)  |                 Rename data availability to data publication                 |                                                  msfew (@fewwwww), Kartin, Xiaohang Yu (@xhyumiracle)                                                  |
-|  [6](/cips/cip-6.md)  | Enforce payment of the gas for a transaction based on a global minimum price |                                                               Callum Waters (@cmwaters)                                                                |
-|  [7](/cips/cip-7.md)  |     Managing Working Groups in the Celestia Improvement Proposal Process     |                                                             Yaz Khoury <[email protected]>                                                              |
-|  [8](/cips/cip-8.md)  |    Roles and Responsibilities of Working Group Chairs in the CIP Process     |                                                             Yaz Khoury <[email protected]>                                                              |
-|  [9](/cips/cip-9.md)  |                          Packet Forward Middleware                           |                                                                 Alex Cheng (@akc2267)                                                                  |
-| [10](/cips/cip-10.md) |                         Coordinated network upgrades                         |                                                               Callum Waters (@cmwaters)                                                                |
-| [11](/cips/cip-11.md) |                              Refund unspent gas                              |                                                                Rootul Patel (@rootulp)                                                                 |
-| [12](/cips/cip-12.md) |                  ICS-29 Relayer Incentivisation Middleware                   |                       Susannah Evans <[email protected]> @womensrights, Aditya Sripal <[email protected]> @AdityaSripal                        |
-| [13](/cips/cip-13.md) |             On-chain Governance Parameters for Celestia Network              |                                            Yaz Khoury <[email protected]>,  Evan Forbes <[email protected]>                                             |
-| [14](/cips/cip-14.md) |                          ICS-27 Interchain Accounts                          | Susannah Evans <[email protected]> (@womensrights), Aidan Salzmann <[email protected]> (@asalzmann), Sam Pochyly <[email protected]> (@sampocs) |
-| [15](/cips/cip-15.md) |                            Discourage memo usage                             |                                                    Rootul Patel (@rootulp), NashQueue (@nashqueue)                                                     |
-| [16](/cips/cip-16.md) |            Make Security Related Governance Parameters Immutable             |                                                               Mingpei CAO (@caomingpei)                                                                |
-| [17](/cips/cip-17.md) |                             Lemongrass Hardfork                              |                                                               Evan Forbes (@evan-forbes)                                                               |
-| [18](/cips/cip-18.md) |              Standardised Gas and Pricing Estimation Interface               |                                                               Callum Waters (@cmwaters)                                                                |
-| [19](/cips/cip-19.md) |                                Shwap Protocol                                |                                                              Hlib Kanunnikov (@Wondertan)                                                              |
-| [20](/cips/cip-20.md) |                          Disable Blobstream module                           |                                                                Rootul Patel (@rootulp)                                                                 |
-| [21](/cips/cip-21.md) |                   Introduce blob type with verified signer                   |                                                               Callum Waters (@cmwaters)                                                                |
-| [22](/cips/cip-22.md) |                         Removing the blobStartIndex                          |                                                                 NashQueue (@Nashqueue)                                                                 |
-| [23](/cips/cip-23.md) |                          Coordinated prevote times                           |                                                               Callum Waters (@cmwaters)                                                                |
+|  [1](./cip-1.md)  |             Celestia Improvement Proposal Process and Guidelines             |                                                             Yaz Khoury <[email protected]>                                                              |
+|  [2](./cip-2.md)  |                             CIP Editor Handbook                              |                                                                 Yaz Khoury (@YazzyYaz)                                                                 |
+|  [3](./cip-3.md)  |                   Process for Approving External Resources                   |                                                                 Yaz Khoury (@YazzyYaz)                                                                 |
+|  [4](./cip-4.md)  |                Standardize data expiry time for pruned nodes                 |                                      Mustafa Al-Bassam (@musalbas), Rene Lubov (@renaynay), Ramin Keene (@ramin)                                       |
+|  [5](./cip-5.md)  |                 Rename data availability to data publication                 |                                                  msfew (@fewwwww), Kartin, Xiaohang Yu (@xhyumiracle)                                                  |
+|  [6](./cip-6.md)  | Enforce payment of the gas for a transaction based on a global minimum price |                                                               Callum Waters (@cmwaters)                                                                |
+|  [7](./cip-7.md)  |     Managing Working Groups in the Celestia Improvement Proposal Process     |                                                             Yaz Khoury <[email protected]>                                                              |
+|  [8](./cip-8.md)  |    Roles and Responsibilities of Working Group Chairs in the CIP Process     |                                                             Yaz Khoury <[email protected]>                                                              |
+|  [9](./cip-9.md)  |                          Packet Forward Middleware                           |                                                                 Alex Cheng (@akc2267)                                                                  |
+| [10](./cip-10.md) |                         Coordinated network upgrades                         |                                                               Callum Waters (@cmwaters)                                                                |
+| [11](./cip-11.md) |                              Refund unspent gas                              |                                                                Rootul Patel (@rootulp)                                                                 |
+| [12](./cip-12.md) |                  ICS-29 Relayer Incentivisation Middleware                   |                       Susannah Evans <[email protected]> @womensrights, Aditya Sripal <[email protected]> @AdityaSripal                        |
+| [13](./cip-13.md) |             On-chain Governance Parameters for Celestia Network              |                                            Yaz Khoury <[email protected]>,  Evan Forbes <[email protected]>                                             |
+| [14](./cip-14.md) |                          ICS-27 Interchain Accounts                          | Susannah Evans <[email protected]> (@womensrights), Aidan Salzmann <[email protected]> (@asalzmann), Sam Pochyly <[email protected]> (@sampocs) |
+| [15](./cip-15.md) |                            Discourage memo usage                             |                                                    Rootul Patel (@rootulp), NashQueue (@nashqueue)                                                     |
+| [16](./cip-16.md) |            Make Security Related Governance Parameters Immutable             |                                                               Mingpei CAO (@caomingpei)                                                                |
+| [17](./cip-17.md) |                             Lemongrass Hardfork                              |                                                               Evan Forbes (@evan-forbes)                                                               |
+| [18](./cip-18.md) |              Standardised Gas and Pricing Estimation Interface               |                                                               Callum Waters (@cmwaters)                                                                |
+| [19](./cip-19.md) |                                Shwap Protocol                                |                                                              Hlib Kanunnikov (@Wondertan)                                                              |
+| [20](./cip-20.md) |                          Disable Blobstream module                           |                                                                Rootul Patel (@rootulp)                                                                 |
+| [21](./cip-21.md) |                   Introduce blob type with verified signer                   |                                                               Callum Waters (@cmwaters)                                                                |
+| [22](./cip-22.md) |                         Removing the blobStartIndex                          |                                                                 NashQueue (@Nashqueue)                                                                 |
+| [23](./cip-23.md) |                          Coordinated prevote times                           |                                                               Callum Waters (@cmwaters)                                                                |
 
 ## Contributing
 
@@ -54,3 +54,13 @@ Files in this repo must conform to [markdownlint](https://github.com/DavidAnson/
 ```shell
 markdownlint --config .markdownlint.yaml '**/*.md'
 ```
+
+### Running the site locally
+
+Prerequisites: 
+1. Install [Rust](https://www.rust-lang.org/tools/install)
+1. Install [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html)
+
+```sh
+mdbook serve -o
+```
diff --git a/book.toml b/book.toml
@@ -0,0 +1,22 @@
+[book]
+authors = []
+language = "en"
+multilingual = false
+title = "Celestia Improvement Proposals (CIPs)"
+description = "The Celestia Improvement Proposal (CIP) process and CIPs."
+theme = "theme"
+src = "cips"
+
+[output.html]
+default-theme = "light"
+preferred-dark-theme = "ayu"
+git-repository-url = "https://github.com/celestiaorg/cips"
+git-repository-icon = "fa-github"
+edit-url-template = "https://github.com/celestiaorg/cips/edit/main/{path}"
+cname = "cips.celestia.org"
+smart-punctuation = true
+theme = "theme"
+
+[output.html.fold]
+enable = false
+level = 0
diff --git a/cips/SUMMARY.md b/cips/SUMMARY.md
@@ -0,0 +1,43 @@
+# Summary
+
+[README.md](../README.md)
+<!-- markdownlint-disable MD025 -->
+# CIPs
+
+- [CIP-1](./cip-1.md)
+- [CIP-2](./cip-2.md)
+- [CIP-3](./cip-3.md)
+- [CIP-4](./cip-4.md)
+- [CIP-5](./cip-5.md)
+- [CIP-6](./cip-6.md)
+- [CIP-7](./cip-7.md)
+- [CIP-8](./cip-8.md)
+- [CIP-9](./cip-9.md)
+- [CIP-10](./cip-10.md)
+- [CIP-11](./cip-11.md)
+- [CIP-12](./cip-12.md)
+- [CIP-13](./cip-13.md)
+- [CIP-14](./cip-14.md)
+- [CIP-15](./cip-15.md)
+- [CIP-16](./cip-16.md)
+- [CIP-17](./cip-17.md)
+- [CIP-18](./cip-18.md)
+- [CIP-19](./cip-19.md)
+- [CIP-20](./cip-20.md)
+- [CIP-21](./cip-21.md)
+- [CIP-22](./cip-22.md)
+- [CIP-23](./cip-23.md)
+
+# CIP template
+
+- [CIP Template](./cip-template.md)
+
+---
+
+# Working Groups
+
+- [WGs overview](./wgs/README.md)
+  - [Data Availability](./wgs/da/README.md)
+  - [Interface](./wgs/interface/README.md)
+  - [ZK](./wgs/zk/README.md)
+    - [Overview of ZK Accounts](./wgs/zk/overview.md)
diff --git a/assets/cip-15/memo-length.svg → cips/assets/cip-15/memo-length.svg b/assets/cip-15/memo-length.svg → cips/assets/cip-15/memo-length.svg
diff --git a/assets/cip-21/blob-v2-share-format.svg → cips/assets/cip-21/blob-v2-share-format.svg b/assets/cip-21/blob-v2-share-format.svg → cips/assets/cip-21/blob-v2-share-format.svg
diff --git a/cips/cip-1.md b/cips/cip-1.md
@@ -1,11 +1,10 @@
----
-cip: 1
-title: Celestia Improvement Proposal Process and Guidelines
-author: Yaz Khoury <[email protected]>
-status: Living
-type: Meta
-created: 2023-04-13
----
+| cip | 1 |
+| - | - |
+| title | Celestia Improvement Proposal Process and Guidelines |
+| author | Yaz Khoury <[email protected]> |
+| status | Living |
+| type | Meta |
+| created | 2023-04-13 |
 
 ## Table of Contents
 
@@ -316,6 +315,8 @@ format. There is a [CIP template](./cip-template.md) to follow.
 Each CIP must begin with an RFC 822 style header preamble, preceded
 and followed by three hyphens (---). This header is also termed
 “front matter” by Jekyll. The headers must appear in the following order.
+In order to display on the CIP site, the frontmatter must be
+formatted in a markdown table.
 
 * `cip`: CIP number (this is determined by the CIP editor)
 * `title`: The CIP title is a few words, not a complete sentence

diff --git a/cips/cip-10.md b/cips/cip-10.md
@@ -1,14 +1,13 @@
----
-cip: 10
-title: Coordinated network upgrades
-description: Protocol for coordinating major network upgrades
-author: Callum Waters (@cmwaters)
-discussions-to: https://forum.celestia.org/t/cip-coordinated-network-upgrades/1367
-status: Final
-type: Standards Track
-category: Core
-created: 2023-12-7
----
+| cip | 10 |
+| - | - |
+| title | Coordinated network upgrades |
+| description | Protocol for coordinating major network upgrades |
+| author | Callum Waters (@cmwaters) |
+| discussions-to | <https://forum.celestia.org/t/cip-coordinated-network-upgrades/1367> |
+| status | Final |
+| type | Standards Track |
+| category | Core |
+| created | 2023-12-07 |
 
 ## Abstract
 

diff --git a/cips/cip-11.md b/cips/cip-11.md
@@ -1,15 +1,14 @@
----
-cip: 11
-title: Refund unspent gas
-description: Refund allocated but unspent gas to the transaction fee payer.
-author: Rootul Patel (@rootulp)
-discussions-to: https://forum.celestia.org/t/cip-refund-unspent-gas/1374
-status: Withdrawn
-withdrawal-reason: The mitigation strategies for the security considerations were deemed too complex.
-type: Standards Track
-category: Core
-created: 2023-12-07
----
+| cip | 11 |
+| - | - |
+| title | Refund unspent gas |
+| description | Refund allocated but unspent gas to the transaction fee payer. |
+| author | Rootul Patel (@rootulp) |
+| discussions-to | <https://forum.celestia.org/t/cip-refund-unspent-gas/1374> |
+| status | Withdrawn |
+| withdrawal-reason | The mitigation strategies for the security considerations were deemed too complex. |
+| type | Standards Track |
+| category | Core |
+| created | 2023-12-07 |
 
 ## Abstract
 

diff --git a/cips/cip-12.md b/cips/cip-12.md
@@ -1,14 +1,13 @@
----
-cip: 12
-title: ICS-29 Relayer Incentivisation Middleware
-description: Adding ics-29 to Celestia to move towards sustainable relayer funding for IBC
-author: Susannah Evans [email protected] @womensrights, Aditya Sripal [email protected] @AdityaSripal
-discussions-to: https://forum.celestia.org/t/cip-relayer-incentivisation-middleware/1383
-status: Review
-type: Standards Track
-category: Core
-created: 2023-12-12
----
+| cip | 12 |
+| - | - |
+| title | ICS-29 Relayer Incentivisation Middleware |
+| description | Adding ics-29 to Celestia to move towards sustainable relayer funding for IBC |
+| author | Susannah Evans <[email protected]> (@womensrights), Aditya Sripal <[email protected]> (@AdityaSripal) |
+| discussions-to | <https://forum.celestia.org/t/cip-relayer-incentivisation-middleware/1383> |
+| status | Review |
+| type | Standards Track |
+| category | Core |
+| created | 2023-12-12 |
 
 ## Abstract