diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6fb7c68e..9eec522e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,13 +2,19 @@ name: docs on: push: - branches: - - main + branches: [main] + paths: + [ + "apps/docs/**", + "packages/data/**", + "packages/group/**", + "packages/identity/**", + "packages/proof/**", + "packages/utils/**" + ] jobs: gh-pages: - runs-on: ubuntu-latest - steps: - uses: actions/checkout@v4 diff --git a/README.md b/README.md index 42b20daf..0e9249ac 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@

- - - Semaphore icon + + + Semaphore icon

@@ -56,6 +56,10 @@ 🗣️ Chat & Support +   |   + + 💻 API Reference + diff --git a/package.json b/package.json index 80986516..d41ccfb5 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "lint": "eslint . --ext .js,.ts,.tsx && yarn workspace semaphore-contracts lint", "format": "prettier -c . && yarn workspace semaphore-docs format", "format:write": "prettier -w . && yarn workspace semaphore-docs format:write", - "docs": "typedoc --cname js.semaphore.pse.dev --githubPages true", + "docs": "typedoc", "version:bump": "yarn workspaces foreach -A --no-private version -d ${0} && yarn version apply --all && yarn remove:stable-version-field && NO_HOOK=1 git commit -am \"chore: v${0}\" && git tag v${0}", "version:publish": "yarn build:libraries && yarn clean:cli-templates && yarn workspaces foreach -A --no-private npm publish --tolerate-republish --access public", "version:release": "changelogithub", diff --git a/typedoc.js b/typedoc.js index c483d12a..5aed1641 100644 --- a/typedoc.js +++ b/typedoc.js @@ -2,15 +2,15 @@ const fs = require("fs") const path = require("path") const EXCLUDE_PKGS = [ + "circuits", + "cli", "cli-template", "cli-template-contracts-hardhat", "cli-template-monorepo-ethers", "cli-template-monorepo-subgraph", - "core", - "circuits", "contracts", - "hardhat", - "cli" + "core", + "hardhat" ] const packagesDir = path.join(__dirname, "packages") const entryPoints = fs @@ -20,6 +20,7 @@ const entryPoints = fs /** @type {import('typedoc').typedocoptions} */ module.exports = { + cname: "js.semaphore.pse.dev", entryPoints, name: "Semaphore SDK", entryPointStrategy: "packages"