feat: resolve links to github on site (#187)

* feat: resolve links to github on site * Update README.md Co-authored-by: Rootul P <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Rootul P <[email protected]>
celestiaorg · Jul 25, 2024 · 6eaf933 · 6eaf933
1 parent eabbfb5
commit 6eaf933
Show file tree

Hide file tree

Showing 23 changed files with 46 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
-# @celestiaorg/CIPs
-
-## Celestia Improvement Proposal (CIP) process repository
+# Celestia Improvement Proposals (CIPs)
 
 See [/cips/README.md](./cips/README.md) for an overview of the CIP process.
 

diff --git a/cips/README.md b/cips/README.md
@@ -26,28 +26,28 @@ Read [CIP-1](./cip-1.md) for information on the CIP process.
 |         №         |                                    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)                                                                |
+|  [2](./cip-2.md)  |                             CIP Editor Handbook                              |                                                                 Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz))                                                                 |
+|  [3](./cip-3.md)  |                   Process for Approving External Resources                   |                                                                 Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz))                                                                 |
+|  [4](./cip-4.md)  |                Standardize data expiry time for pruned nodes                 |                                      Mustafa Al-Bassam ([@musalbas](https://github.com/musalbas)), Rene Lubov ([@renaynay](https://github.com/renaynay)), Ramin Keene ([@ramin](https://github.com/ramin))                                       |
+|  [5](./cip-5.md)  |                 Rename data availability to data publication                 |                                                  msfew ([@fewwwww](https://github.com/fewwwww)), Kartin, Xiaohang Yu ([@xhyumiracle](https://github.com/xhyumiracle))                                                  |
+|  [6](./cip-6.md)  | Enforce payment of the gas for a transaction based on a global minimum price |                                                               Callum Waters ([@cmwaters](https://github.com/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                        |
+|  [9](./cip-9.md)  |                          Packet Forward Middleware                           |                                                                 Alex Cheng ([@akc2267](https://github.com/akc2267))                                                                  |
+| [10](./cip-10.md) |                         Coordinated network upgrades                         |                                                               Callum Waters ([@cmwaters](https://github.com/cmwaters))                                                                |
+| [11](./cip-11.md) |                              Refund unspent gas                              |                                                                Rootul Patel ([@rootulp](https://github.com/rootulp))                                                                 |
+| [12](./cip-12.md) |                  ICS-29 Relayer Incentivisation Middleware                   |                       Susannah Evans <[email protected]> ([@womensrights](https://github.com/womensrights)), Aditya Sripal <[email protected]> ([@AdityaSripal](https://github.com/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 IndexWrapper                           |                                                                 NashQueue (@Nashqueue)                                                                 |
-| [23](./cip-23.md) |                          Coordinated prevote times                           |                                                               Callum Waters (@cmwaters)                                                                |
+| [14](./cip-14.md) |                          ICS-27 Interchain Accounts                          | Susannah Evans <[email protected]> ([@womensrights](https://github.com/womensrights)), Aidan Salzmann <[email protected]> ([@asalzmann](https://github.com/asalzmann)), Sam Pochyly <[email protected]> ([@sampocs](https://github.com/sampocs)) |
+| [15](./cip-15.md) |                            Discourage memo usage                             |                                                    Rootul Patel ([@rootulp](https://github.com/rootulp)), NashQueue ([@nashqueue](https://github.com/nashqueue))                                                     |
+| [16](./cip-16.md) |            Make Security Related Governance Parameters Immutable             |                                                               Mingpei CAO ([@caomingpei](https://github.com/caomingpei))                                                                |
+| [17](./cip-17.md) |                             Lemongrass Hardfork                              |                                                               Evan Forbes ([@evan-forbes](https://github.com/evan-forbes))                                                               |
+| [18](./cip-18.md) |              Standardised Gas and Pricing Estimation Interface               |                                                               Callum Waters ([@cmwaters](https://github.com/cmwaters))                                                                |
+| [19](./cip-19.md) |                                Shwap Protocol                                |                                                              Hlib Kanunnikov ([@Wondertan](https://github.com/Wondertan))                                                              |
+| [20](./cip-20.md) |                          Disable Blobstream module                           |                                                                Rootul Patel ([@rootulp](https://github.com/rootulp))                                                                 |
+| [21](./cip-21.md) |                   Introduce blob type with verified signer                   |                                                               Callum Waters ([@cmwaters](https://github.com/cmwaters))                                                                |
+| [22](./cip-22.md) |                          Removing the IndexWrapper                           |                                                                 NashQueue ([@Nashqueue](https://github.com/Nashqueue))                                                                 |
+| [23](./cip-23.md) |                          Coordinated prevote times                           |                                                               Callum Waters ([@cmwaters](https://github.com/cmwaters))                                                                |
 
 ## Contributing
 

diff --git a/cips/cip-1.md b/cips/cip-1.md
@@ -350,11 +350,11 @@ value must be:
 
 or
 
-> Random J. User (@username)
+> Random J. User ([@username](https://github.com/username))
 
 or
 
-> Random J. User (@username) &lt;<[email protected]>&gt;
+> Random J. User ([@username](https://github.com/username) &lt;<[email protected]>&gt;
 
 if the email address and/or GitHub username is included, and
 
@@ -580,10 +580,10 @@ decision (it's not like such decisions can't be reversed :)).
 
 The current CIP editors are
 
-* Yaz Khoury (@YazzyYaz)
-* Josh Stein (@jcstein)
-* Ethan Buchman (@ebuchman)
-* Rootul Patel (@rootulp)
+* Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz))
+* Josh Stein ([@jcstein](https://github.com/jcstein))
+* Ethan Buchman ([@ebuchman](https://github.com/ebuchman))
+* Rootul Patel ([@rootulp](https://github.com/rootulp))
 
 If you would like to become a CIP editor, please check [CIP-2](./cip-2.md).
 

diff --git a/cips/cip-10.md b/cips/cip-10.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Coordinated network upgrades |
 | description | Protocol for coordinating major network upgrades |
-| author | Callum Waters (@cmwaters) |
+| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) |
 | discussions-to | <https://forum.celestia.org/t/cip-coordinated-network-upgrades/1367> |
 | status | Final |
 | type | Standards Track |

diff --git a/cips/cip-11.md b/cips/cip-11.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Refund unspent gas |
 | description | Refund allocated but unspent gas to the transaction fee payer. |
-| author | Rootul Patel (@rootulp) |
+| author | Rootul Patel ([@rootulp](https://github.com/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. |

diff --git a/cips/cip-12.md b/cips/cip-12.md
@@ -2,7 +2,7 @@
 | - | - |
 | 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) |
+| author | Susannah Evans <[email protected]> ([@womensrights](https://github.com/womensrights)), Aditya Sripal <[email protected]> ([@AdityaSripal](https://github.com/AdityaSripal)) |
 | discussions-to | <https://forum.celestia.org/t/cip-relayer-incentivisation-middleware/1383> |
 | status | Review |
 | type | Standards Track |

diff --git a/cips/cip-14.md b/cips/cip-14.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | ICS-27 Interchain Accounts |
 | description | Adding ICS-27 Interchain Accounts to Celestia to enable cross-chain account management |
-| author | Susannah Evans <[email protected]> (@womensrights), Aidan Salzmann <[email protected]> (@asalzmann), Sam Pochyly <[email protected]> (@sampocs) |
+| author | Susannah Evans <[email protected]> ([@womensrights](https://github.com/womensrights)), Aidan Salzmann <[email protected]> ([@asalzmann](https://github.com/asalzmann)), Sam Pochyly <[email protected]> ([@sampocs](https://github.com/sampocs)) |
 | discussions-to | <https://forum.celestia.org/t/moving-toward-safer-and-more-aligned-tia-liquid-staking/1422> |
 | status | Final |
 | type | Standards Track |

diff --git a/cips/cip-15.md b/cips/cip-15.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Discourage memo usage |
 | description | Discourage memo usage by modifying two auth params. |
-| author | Rootul Patel (@rootulp), NashQueue (@nashqueue) |
+| author | Rootul Patel ([@rootulp](https://github.com/rootulp)), NashQueue ([@nashqueue](https://github.com/nashqueue)) |
 | discussions-to | <https://forum.celestia.org/t/cip-discourage-memo-usage/1508> |
 | status | Draft |
 | type | Standards Track |

diff --git a/cips/cip-16.md b/cips/cip-16.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Make Security Related Governance Parameters Immutable |
 | description | Consensus-related parameters should not be modified via on-chain governance in the Celestia network. |
-| author | Mingpei CAO (@caomingpei) |
+| author | [@caomingpei](https://github.com/caomingpei) |
 | discussions-to | <https://forum.celestia.org/t/cip-make-security-related-governance-parameters-immutable/1566> |
 | status | Draft |
 | type | Standards Track |

diff --git a/cips/cip-17.md b/cips/cip-17.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Lemongrass Hardfork |
 | description | Reference specifications included in the Lemongrass Hardfork |
-| author | Evan Forbes (@evan-forbes) |
+| author | [@evan-forbes](https://github.com/evan-forbes) |
 | discussions-to | <https://forum.celestia.org/t/lemongrass-hardfork/1589> |
 | status | Final |
 | type | Meta |

diff --git a/cips/cip-18.md b/cips/cip-18.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Standardised Gas and Pricing Estimation Interface |
 | description | A standardised interface for estimating gas usage and gas pricing for transactions |
-| author | Callum Waters (@cmwaters) |
+| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) |
 | discussions-to | <https://forum.celestia.org/t/cip-standardised-gas-and-pricing-estimation-interface/1621> |
 | status | Review |
 | type | Standards Track |

diff --git a/cips/cip-19.md b/cips/cip-19.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Shwap Protocol |
 | description | Shwap - a new messaging framework for DA and sampling |
-| author | Hlib Kanunnikov (@Wondertan) |
+| author | Hlib Kanunnikov ([@Wondertan](https://github.com/Wondertan)) |
 | discussions-to | <https://forum.celestia.org/t/cip-shwap-protocol/1551> |
 | status | Review |
 | type | Standards Track |

diff --git a/cips/cip-2.md b/cips/cip-2.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | CIP Editor Handbook |
 | description | Handy reference for CIP editors and those who want to become one |
-| author | Yaz Khoury (@YazzyYaz) |
+| author | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) |
 | discussions-to | <https://forum.celestia.org> |
 | status | Draft |
 | type | Informational |

diff --git a/cips/cip-20.md b/cips/cip-20.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Disable Blobstream module |
 | description | Disable the Blobstream state machine module |
-| author | Rootul Patel (@rootulp) |
+| author | Rootul Patel ([@rootulp](https://github.com/rootulp)) |
 | discussions-to | <https://forum.celestia.org/t/cip-disable-blobstream-module/1693> |
 | status | Final |
 | type | Standards Track |

diff --git a/cips/cip-21.md b/cips/cip-21.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Introduce blob type with verified signer |
 | description | Introduce a new blob type that can be submitted whereby the signer address is included and verified. |
-| author | Callum Waters (@cmwaters) |
+| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) |
 | discussions-to | <https://forum.celestia.org/t/cip-blobs-with-verified-author> |
 | status | Review |
 | type | Standards Track |

diff --git a/cips/cip-22.md b/cips/cip-22.md
@@ -1,7 +1,7 @@
 | cip | 22 |
 | - | - |
 | title | Removing the IndexWrapper |
-| author | NashQueue (@Nashqueue) |
+| author | NashQueue ([@Nashqueue](https://github.com/Nashqueue)) |
 | discussions-to | <https://forum.celestia.org/t/achieving-trust-minimized-light-clients-through-zk-proofs-instead-of-fraud-proofs/1759> |
 | status | Review |
 | type | Standards Track |

diff --git a/cips/cip-23.md b/cips/cip-23.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Coordinated prevote times |
 | description | Scheduled prevote times for consistent blocks |
-| author | Callum Waters (@cmwaters) |
+| author | Callum Waters ([@cmwaters](https://github.com/cmwaters)) |
 | discussions-to | <https://forum.celestia.org/t/coordinated-start-time-intervals/1768> |
 | status | Draft |
 | type | Standards Track |

diff --git a/cips/cip-3.md b/cips/cip-3.md
@@ -2,7 +2,7 @@
 | - | - |
 | title | Process for Approving External Resources |
 | description | Requirements and process for allowing new origins of external resources |
-| author | Yaz Khoury (@YazzyYaz) |
+| author | Yaz Khoury ([@YazzyYaz](https://github.com/YazzyYaz)) |
 | discussions-to | <https://forum.celestia.org> |
 | status | Draft |
 | type | Meta |