Skip to content
Draft

Docs #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
de373ee
wip
AlexanderKolberg Aug 12, 2025
4804fac
WIP: jsdocs
AlexanderKolberg Aug 13, 2025
d24182d
rename "nfts" to "collectible". fix wrong types in jsdocs
mithatakbulut Aug 19, 2025
bb94141
eslint-disable: generate-hook-docs.cjs
mithatakbulut Aug 19, 2025
2942ff1
include new dependencies and scripts
mithatakbulut Aug 26, 2025
7e9f795
Enhance hook documentation generation by adding detailed extraction o…
mithatakbulut Aug 26, 2025
f98c498
autogenerated: READMEs for hook docs categories
mithatakbulut Aug 26, 2025
be5641d
autogenerated: docs of hooks - more polished and better structured
mithatakbulut Aug 26, 2025
1502281
Refactor hook documentation generation to use MDX format instead of M…
mithatakbulut Aug 26, 2025
c39a7c8
autogenerated: file extensions get changed to mdx from md
mithatakbulut Aug 26, 2025
2a6bfea
remove duplicate intro section. we do it in frontmatter metadata
mithatakbulut Aug 26, 2025
a9226ce
autogenerated: remove intro title and description, just keep frontmat…
mithatakbulut Aug 26, 2025
83d3765
fix(docs): resolve nested code block formatting in hook documentation…
mithatakbulut Aug 26, 2025
77af539
autogenerated: fixed double nested example codes
mithatakbulut Aug 26, 2025
9252e94
Merge pull request #516 from 0xsequence/docs-2
AlexanderKolberg Sep 9, 2025
4d0acdd
wip
AlexanderKolberg Aug 22, 2025
fd9d9c3
Merge branch 'master' into docs
AlexanderKolberg Sep 9, 2025
2ed06f6
Merge branch 'docs' into refactor-script-to-generate-polished-docs
mithatakbulut Sep 9, 2025
2afcb7e
update pnpm-lock
mithatakbulut Sep 9, 2025
83c4d07
Merge pull request #522 from 0xsequence/refactor-script-to-generate-p…
AlexanderKolberg Sep 9, 2025
c4fa9ae
Remove the basic usage section from the hook documentation generation…
mithatakbulut Sep 11, 2025
deae0a0
docs:generate
mithatakbulut Sep 11, 2025
f8cb06f
Merge pull request #538 from 0xsequence/refactor-generate-hook-docs
AlexanderKolberg Sep 11, 2025
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
61 changes: 61 additions & 0 deletions .github/workflows/generate-hook-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Generate Hook Documentation

on:
push:
branches:
- main
- master
paths:
- 'sdk/src/react/hooks/**/*.ts'
- 'sdk/src/react/hooks/**/*.tsx'
pull_request:
paths:
- 'sdk/src/react/hooks/**/*.ts'
- 'sdk/src/react/hooks/**/*.tsx'
workflow_dispatch:

jobs:
generate-docs:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Install pnpm
uses: pnpm/action-setup@v2
with:
version: 8

- name: Install dependencies
run: |
cd sdk
pnpm install --frozen-lockfile

- name: Generate hook documentation
run: |
cd sdk
pnpm run docs:hooks

- name: Check if documentation changed
id: check-changes
run: |
if [[ -n $(git status --porcelain sdk/docs/hooks) ]]; then
echo "changes=true" >> $GITHUB_OUTPUT
else
echo "changes=false" >> $GITHUB_OUTPUT
fi

- name: Commit documentation changes
if: steps.check-changes.outputs.changes == 'true' && github.event_name == 'push'
run: |
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add sdk/docs/hooks
git commit -m "docs: update hook documentation [skip ci]"
git push
Loading