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

fix: pull README.md into CIPs dir, fix CC0 links, add dropdown for CIPs #179

Merged
merged 16 commits into from
Jul 22, 2024
Merged

fix: pull README.md into CIPs dir, fix CC0 links, add dropdown for CIPs #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
274f6a6
Update book.toml
jcstein Jul 22, 2024
89d524f
feat: move readme out, menu collapse on
jcstein Jul 22, 2024
22916fc
fix: path of wgs-overview
jcstein Jul 22, 2024
68ab3fe
fix: path
jcstein Jul 22, 2024
1b7ca4a
fix: path
jcstein Jul 22, 2024
09de43f
fix: resolve #177
jcstein Jul 22, 2024
d59ab4d
fix: remove extra file
jcstein Jul 22, 2024
04e25e6
fix: use index.html for WGs overview page
jcstein Jul 22, 2024
cc21720
feat: use README.md for main overview so it shows on GH
jcstein Jul 22, 2024
659ecd0
feat: use same for wgs/README.md
jcstein Jul 22, 2024
693a5b5
fix: link on readme
jcstein Jul 22, 2024
6103132
docs: copy edit
jcstein Jul 22, 2024
361430d
fix: link to wgs overview
jcstein Jul 22, 2024
550a240
feat: resolve diff between jcstein and celestiaorg branches
jcstein Jul 22, 2024
fdffaa6
fix: lint
jcstein Jul 22, 2024
4c14da6
docs: suggestion from review
jcstein Jul 22, 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
67 changes: 4 additions & 63 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,66 +1,7 @@
# Celestia Improvement Proposal (CIP) process
# @celestiaorg/CIPs

Read [CIP-1](./cip-1.md) for information on the CIP process.
## Celestia Improvement Proposal (CIP) process repository

## Meetings
See [/cips/README.md](./cips/README.md) for an overview of the CIP process.

| № | Date | Agenda | Notes | Recording |
|:--:|:-----------------:|:--------------------------------------------------------:|:-------------------------------------------------------------------------:|:---------------------------------------------------------------:|
| 1 | November 29, 2023 | [Agenda](https://github.com/celestiaorg/CIPs/issues/8) | [Tweet Thread](https://x.com/JoshCStein/status/1729893879191621702) | [Recording](https://www.youtube.com/watch?v=EhWHHmPo_5Q) |
| 2 | December 13, 2023 | [Agenda](https://github.com/celestiaorg/CIPs/issues/22) | [Tweet Thread](https://x.com/JoshCStein/status/1734967567075168697) | [Recording](https://www.youtube.com/watch?v=yYt600kvf4g) |
| 3 | January 24, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/40) | [Tweet Thread](https://x.com/JoshCStein/status/1750187535911837848?s=20) | [Recording](https://www.youtube.com/watch?v=g_8e3h6iixM) |
| 4 | February 6, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/61) | [Tweet Thread](https://x.com/JoshCStein/status/1754898166313337310?s=20) | [Recording](https://www.youtube.com/watch?v=izDnDHZEbxg) |
| 5 | February 20, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/71) | [Tweet Thread](https://twitter.com/JoshCStein/status/1759972091724526084) | [Recording](https://youtube.com/live/WFPEMAuGEM0?feature=share) |
| 6 | March 6, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/87) | [Tweet Thread](https://twitter.com/JoshCStein/status/1765407703462031563) | [Recording](https://www.youtube.com/watch?v=DEAkzrhSwMA) |
| 7 | March 20, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/95) | [Tweet Thread](https://twitter.com/JoshCStein/status/1770480641290744157) | [Recording](https://www.youtube.com/watch?v=B2NyDWht7xU) |
| 8 | April 3, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/107) | [Tweet Thread](https://twitter.com/JoshCStein/status/1775538935285862747) | [Recording](https://www.youtube.com/watch?v=vBrjSExfRO8) |
| 9 | April 17, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/127) | [Tweet Thread](https://twitter.com/JoshCStein/status/1780612265667924032) | [Recording](https://www.youtube.com/watch?v=Qwir10r9o7k) |
| 10 | April 30, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/134) | [Tweet Thread](https://x.com/JoshCStein/status/1785309248248828133) | [Recording](https://www.youtube.com/watch?v=zWQsvPqPkC8) |
| 11 | May 22, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/142) | [Tweet Thread](https://x.com/JoshCStein/status/1793312125235999082) | [Recording](https://www.youtube.com/watch?v=g6PMMaMmpxg) |
| 12 | June 5, 2024 | [Agenda](https://github.com/celestiaorg/CIPs/issues/149) | [Tweet Thread](https://x.com/JoshCStein/status/1798381092493504830) | [Recording](https://www.youtube.com/watch?v=kV5_ANNhixI) |

## Celestia Improvement Proposals (CIPs)

| № | Title | Author(s) |
|:---------------------:|:----------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [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

Files in this repo must conform to [markdownlint](https://github.com/DavidAnson/markdownlint). Install [markdownlint](https://github.com/DavidAnson/markdownlint) and then run:

```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
```
See the [WGs directory](./cips/wgs/README.md) for Working Groups within the CIP process.
2 changes: 1 addition & 1 deletion book.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ smart-punctuation = true
theme = "theme"

[output.html.fold]
enable = false
enable = true
level = 0
Loading