Skip to content

Conversation

@smol-ninja
Copy link
Member

This PR adds contract references for all the protocols.

Note

  • As discussed, the dependencies from evm-utils are added individually to each of the protocols references for a better user experience.
  • I have set onBrokenLinks to warn in docusaurus config file (search TODO). This will allow us to work asynchronously without having to fix broken links in all pages, which would eventually avoid too many conflicts.
  • I didn't fix broken links which we will do in the end (again to avoid conflicts).
  • I used Claude to refactor autogen script. I would suggest to not focus on the autogen code that much (other than a brief look) since in the end the generated output matters more then the autogen code itself. Also, the maintenance cost for autogen script has gone down tremendously because of the AI.

@PaulRBerg
Copy link
Member

PaulRBerg commented Oct 20, 2025

the maintenance cost for autogen script has gone down tremendously because of the AI.

This is true, but it would have been helpful to have a stack of two PRs:

  1. One that modifies the autogen script
  2. Another that builds on top of it to introduce the other change

To ease the review and separate concerns.

But anyway, not a biggy.


It would also be great to handle #329 in the near future

script: update autogen to deal with malformed code block endings with asterisks
@smol-ninja smol-ninja merged commit a113d9e into staging Oct 23, 2025
1 check was pending
@smol-ninja smol-ninja deleted the references branch October 23, 2025 11:00
andreivladbrg added a commit that referenced this pull request Oct 23, 2025
* update custom deployments page (#382)

* update custom deployments page

* remove just as requirement from custom deployments

* andrei's feedback

* add step 4 for comptroller

---------

Co-authored-by: Andrei Vlad Birgaoanu <andreivladbrg@gmail.com>

* style: add overrides for md and mdx

* refactor: flow status page (#386)

* chore: use snapshot time instead of start time in Stream characteristics table

* Bump sdk and update governance page (#372)

* bump sdk

* add latest contract deployments

* bump sdk

* feat: comptrollers table

refactor: hardcode values instead of making rpc calls
refactor: update governance page

* refactor: update supported chains

chore: add PR NOTEs

* chore: nitpick

* bump sablier

* chore: add todo about reference links

chore: bump deps

* chore: fix deps

* Feedback on PR #372 (#388)

* feat: add getLatestLockupChainIds helper function
refactor: getChainCount function to compute the count on its own
refactor: query comptroller address from sdk
chore: update words on the governance page
refactor: create snippet for deployment note

* capitalize comptroller
remove redundant check from ComptrollersTable

---------

Co-authored-by: smol-ninja <shubhamy2015@gmail.com>

* feat: add contract references (#383)

* docs: add contract references and update autogen script using Claude

* fix: add evm-utils to gitmodules
script: update autogen to deal with malformed code block endings with asterisks

* feat: add concepts section for variable claim airdrop (#387)

* feat: add concepts section for variable claim airdrop

* update diagrams and add VCA campaign
update access control and add claimTo and ClaimViaSig

* andrei's suggestion

* docs: add use cases for VCA airdrop
docs: use claimTo in VCA diagram
docs: add compatibility column to airdrops access control

* refactor: update lockup examples with latest version (#391)

* refactor: update lockup examples with latest version

refactor: update example GH url links
refactor: remove staking page

* change type import

* fix conflicts

---------

Co-authored-by: smol-ninja <shubhamy2015@gmail.com>

* revert from warn to throw

* refactor: update airdrops examples (#392)

* refactor: update airdrops examples

* refactor: hide campaign verifiction page

* chore: wordings

* fix formatting

---------

Co-authored-by: smol-ninja <shubhamy2015@gmail.com>

* fix formatting

* fix: broken links

* refactor: update flow examples

* fix: broke links

* remove Broker from flow example

* update lockfile

* fix: vercel issue

---------

Co-authored-by: Shubham Yadav <shubhamy2015@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants