Skip to content

Commit 2f4d650

Browse files
PaulRBergsmol-ninja
andcommitted
refactor: comprehensive API documentation modernization and toolchain 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 <[email protected]>
1 parent e656c7d commit 2f4d650

File tree

952 files changed

+83271
-11577
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

952 files changed

+83271
-11577
lines changed

.editorconfig

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ indent_size = 2
1111
indent_style = space
1212
insert_final_newline = true
1313
trim_trailing_whitespace = true
14+
15+
[justfile]
16+
indent_size = 4

.eslintignore

Lines changed: 0 additions & 8 deletions
This file was deleted.

.eslintrc.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/workflows/cd.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: "Deploy to Vercel"
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches: ["main"]
7+
8+
jobs:
9+
cd:
10+
environment: "production"
11+
runs-on: "ubuntu-latest"
12+
steps:
13+
- name: "Check out the repo"
14+
uses: "actions/checkout@v4"
15+
16+
- name: "Set up devkit"
17+
uses: "sablier-labs/devkit/actions/setup@main"
18+
with:
19+
package-manager: "bun"
20+
21+
- name: "Run the code checks"
22+
run: "just full-check"
23+
24+
- name: "Deploy to Vercel"
25+
env:
26+
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
27+
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
28+
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
29+
run: "just deploy"
30+
31+
- name: "Add summary"
32+
run: |
33+
echo "## Continuous Deployment results" >> $GITHUB_STEP_SUMMARY
34+
echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
File renamed without changes.

.github/workflows/deploy.yml

Lines changed: 0 additions & 47 deletions
This file was deleted.

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
# directories
22
.cache-loader
33
.docusaurus
4+
.repomix
45
build
56
node_modules
7+
src/autogen/**/*.mdx
68

79
# files
810
*.env
911
*.log
1012
*.tsbuildinfo
1113
.DS_Store
1214
.eslintcache
13-
.pnp.*
1415
package-lock.json
15-
pnpm-lock.yaml
16-
yarn.lock

.lintstagedrc.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/**
2+
* @type {import("lint-staged").Configuration}
3+
*/
4+
module.exports = {
5+
"*.{css,js,json,jsonc,jsx,ts,tsx}": "bun biome check --write",
6+
"*.{js,jsx,ts,tsx}": "bun biome lint --write --only correctness/noUnusedImports",
7+
"*.{md,mdx,yaml,yml}": "bun prettier --cache --write",
8+
"*.{md,mdx}": "bun eslint --cache --fix",
9+
};

.lintstagedrc.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

.prettierignore

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
# directories
2-
.cache-loader
32
.docusaurus
43
build
54
node_modules
65
repos
76

87
# files
9-
.pnp.*
10-
package-lock.json
11-
pnpm-lock.yaml
8+
src/autogen/**/*.mdx

0 commit comments

Comments
 (0)