Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(WIP): add v0 site #168

Closed
wants to merge 7 commits into from
Closed

feat(WIP): add v0 site #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
277f001
feat: add v0 site
jcstein Jul 16, 2024
f6dac41
feat: add mdbook.yml
jcstein Jul 16, 2024
e697bdb
feat: add readme to menu
jcstein Jul 16, 2024
849def4
fix: use internal link
jcstein Jul 16, 2024
727a594
fix: multiple top level
jcstein Jul 16, 2024
b96942d
feat: add favicon, custom .hbs, move assets, fix readme
jcstein Jul 18, 2024
911347f
feat: resolve conflicts
jcstein Jul 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/workflows/mdbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Sample workflow for building and deploying a mdBook site to GitHub Pages
#
# To get started with mdBook see: https://rust-lang.github.io/mdBook/index.html
#
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.36
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
book
index.html
1 change: 1 addition & 0 deletions .markdownlint.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
"MD025": false # Disable rule for multiple top-level headers
48 changes: 24 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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](./cips/cip-1.md) for information on the CIP process.

## Meetings

Expand All @@ -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](./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) |

## Contributing

Expand Down
22 changes: 22 additions & 0 deletions book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
[book]
authors = []
language = "en"
multilingual = false
src = "src"
title = "Celestia Improvement Proposals (CIPs)"
description = "The Celestia Improvement Proposal (CIP) process"
theme = "theme"

[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
39 changes: 39 additions & 0 deletions src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Summary


[README.md](../README.md)

# CIPs
- [CIP-1](./cips/cip-1.md)
- [CIP-2](./cips/cip-2.md)
- [CIP-3](./cips/cip-3.md)
- [CIP-4](./cips/cip-4.md)
- [CIP-5](./cips/cip-5.md)
- [CIP-6](./cips/cip-6.md)
- [CIP-7](./cips/cip-7.md)
- [CIP-8](./cips/cip-8.md)
- [CIP-9](./cips/cip-9.md)
- [CIP-10](./cips/cip-10.md)
- [CIP-11](./cips/cip-11.md)
- [CIP-12](./cips/cip-12.md)
- [CIP-13](./cips/cip-13.md)
- [CIP-14](./cips/cip-14.md)
- [CIP-15](./cips/cip-15.md)
- [CIP-16](./cips/cip-16.md)
- [CIP-17](./cips/cip-17.md)
- [CIP-18](./cips/cip-18.md)
- [CIP-19](./cips/cip-19.md)
- [CIP-20](./cips/cip-20.md)
- [CIP-21](./cips/cip-21.md)
- [CIP-22](./cips/cip-22.md)
- [CIP-23](./cips/cip-23.md)

# CIP template

- [CIP Template](./cips/cip-template.md)

# Working Groups

- [Data Availability](./wgs/da/README.md)
- [Interface](./wgs/interface/README.md)
- [zk](./wgs/zk/README.md)
0 assets/cip-15/memo-length.svg → src/assets/cip-15/memo-length.svg
View file
Open in desktop
File renamed without changes
0 assets/cip-21/blob-v2-share-format.svg → src/assets/cip-21/blob-v2-share-format.svg
View file
Open in desktop
File renamed without changes
0 cips/cip-1.md → src/cips/cip-1.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-10.md → src/cips/cip-10.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-11.md → src/cips/cip-11.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-12.md → src/cips/cip-12.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-13.md → src/cips/cip-13.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-14.md → src/cips/cip-14.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-15.md → src/cips/cip-15.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-16.md → src/cips/cip-16.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-17.md → src/cips/cip-17.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-18.md → src/cips/cip-18.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-19.md → src/cips/cip-19.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-2.md → src/cips/cip-2.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-20.md → src/cips/cip-20.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-21.md → src/cips/cip-21.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-22.md → src/cips/cip-22.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-23.md → src/cips/cip-23.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-3.md → src/cips/cip-3.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-4.md → src/cips/cip-4.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-5.md → src/cips/cip-5.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-6.md → src/cips/cip-6.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-7.md → src/cips/cip-7.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-8.md → src/cips/cip-8.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-9.md → src/cips/cip-9.md
View file
Open in desktop
File renamed without changes.
0 cips/cip-template.md → src/cips/cip-template.md
View file
Open in desktop
File renamed without changes.
0 wgs/da/README.md → src/wgs/da/README.md
View file
Open in desktop
File renamed without changes.
0 wgs/interface/README.md → src/wgs/interface/README.md
View file
Open in desktop
File renamed without changes.
0 wgs/zk/README.md → src/wgs/zk/README.md
View file
Open in desktop
File renamed without changes.
Binary file added theme/favicon.ico
View file
Open in desktop
Binary file not shown.
Binary file added theme/favicon.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading