Conversation
b2f4839 to
fe0ebaf
Compare
fe0ebaf to
2e5f6d1
Compare
ecbdb5c to
d55bdac
Compare
d55bdac to
0da211c
Compare
0da211c to
ec05925
Compare
ec05925 to
104f14d
Compare
|
The PR is now ready for your review @sablier-labs/evm |
eda32e5 to
0e7fc98
Compare
0e7fc98 to
5cbe647
Compare
5cbe647 to
1e8cc1b
Compare
1e8cc1b to
84a826a
Compare
|
Click to view recordingScreen.Recording.2025-04-30.at.11.26.41.mov |
smol-ninja
left a comment
There was a problem hiding this comment.
Phenomenal work @PaulRBerg.
smol-ninja
left a comment
There was a problem hiding this comment.
Just had a second look and looks good to me now. Just pushed a new commit to fix some warnings and other minor errors.
be29596 to
d04b7d2
Compare
d04b7d2 to
c87a137
Compare
|
Received a question from a user (SYNTHR) for which the docs in this PR would have been helpful: 
Specifically, the new section about "Choosing Your Approach": 
|
|
This new version auto-generates queries in the API section. The idea behind the Queries page under Indexers was to provide popular queries stemming from user requests over time. It was a good place to point to for copy-paste examples. As a general feedback for these auto-generate queries and descriptions: since they can already be found in the indexer's page, in the schema, in the Hasura (or similar explorer) section describing the endpoint, I don't see a point in duplicating them yet again in our docs. They don't provide extra value and they increase maintanance cost since we'll have to remember re-generating if/when we update our endpoints. I'd propose replacing them with the old custom queries and maybe adding a note about being able to find all filters and field descriptions using Hasura, if there's no human input necessary. |
|
We can add some default queries, too. But let's please do that after we merge the PR because it's been open for a long time. And let's only add a handful - getting some streams and some campaigns, and that's it. Also, the Indexers repo provides some default queries now (though they use the
The maintenance cost is super low now, because everything is automated. Bumping the |
The current docs contain the most requested ones e.g. streams from a campaign, campaigns with an asset, recipients who claimed etc. They can be probably be copy-pasted. |
df8af86 to
2f4d650
Compare
2f4d650 to
0757f6f
Compare
0757f6f to
8df3be1
Compare
23104a4 to
c5c76a4
Compare
|
TODOs left here:
|
… upgrade This major refactor modernizes the entire documentation infrastructure and API reference system: **Toolchain Modernization:** - Migrate from ESLint/Prettier YAML configs to Biome for faster, unified formatting and linting - Replace package.json scripts with Just CLI for improved task automation - Add comprehensive autogeneration CLI tools for GraphQL schema documentation - Implement structured config organization (plugins, presets, redirects, sidebars, theme-config) - Upgrade to deployments package for better contract management **API Documentation Restructure:** - Complete overhaul of API documentation structure with new identifier system - Add comprehensive GraphQL schema documentation for both Envio and The Graph indexers - Generate 500+ auto-generated GraphQL type, query, input, and enum documentation files - Restructure airdrops and flow API sections with consistent categorization - Implement unified indexer documentation patterns across all API endpoints - Add getting started guides and overview sections for better developer onboarding **Infrastructure Improvements:** - Modernize GitHub Actions with new CD pipeline and workflow optimization - Update VS Code settings and extensions for better developer experience - Implement lint-staged configuration for automated code quality checks - Add comprehensive redirects management for backward compatibility - Organize Docusaurus configuration into modular, maintainable files **Developer Experience:** - Add autogeneration scripts for maintaining up-to-date API documentation - Implement consistent file naming and organization patterns - Provide clear migration paths from legacy endpoints to new indexer systems - Establish foundation for automated documentation maintenance workflows This refactor positions the documentation system for scalable maintenance while providing comprehensive, auto-generated API references that stay synchronized with the underlying GraphQL schemas. Co-Authored-By: smol-ninja <shubhamy2015@gmail.com>
c5c76a4 to
cb94cb1
Compare
|
Reply for #349 (comment) LGTM. I think we can merge. We don't mention anywhere that the schema (and ids) has undergone changes in August 2025, should we add that somewhere? |
|
I don't think it would be worth mentioning that here in the docs as per the explanation given here. There are other priorities at Sablier. |
Explainer
This PR significantly reduces the maintenance cost of the documentation site by auto-generating:
sablierpackage, whose source code is available at https://github.com/sablier-labs/sdk@sablier/indexerspackage, whose source code is available at https://github.com/sablier-labs/indexersIn addition, this PR has also made a few other improvements, such as integrating BiomeJS and polishing the ESLint config (using ESLint v9 now).
Issues Closed