docs: API reference and getting-started guide for developers.pezkuwichain.io (#21)

* docs: generate the API reference for developers.pezkuwichain.io

Add TypeDoc (0.28.20) and `yarn docs`, which builds the reference for the
nine public API packages from src/ into build-docs/, with a landing page
and a getting-started guide whose examples were run against the live
network. The PR workflow builds it so a broken doc comment or config is
caught before merge.

docs/ held only a redirect to polkadot.js.org; it now holds the guide
sources. The README, packages/api/README.md and three CHANGELOG entries
linked to js.pezkuwichain.app, a domain that is not ours and is listed
for sale; they now point to developers.pezkuwichain.io, the Pezkuwi
Portal, or the upstream polkadot.js.org pages the entries came from.

* ci(docs): deploy the reference to developers.pezkuwichain.io

On every master push that changes the generated reference, build it with
`yarn docs` and publish it to the web host the same way pezkuwi-apps
publishes the portal: an approved production environment holds the deploy
key, the bundle is unpacked into releases/<sha>, and going live is one
rename of the current symlink. The switch is checked through nginx for the
public name (deploy sha, index, main.js, search index) and rolled back if
the new release is not served. workflow_dispatch with rollback_to makes an
earlier release live again.

Release-bot version bumps ([CI Skip]) and changes that cannot affect the
output do not ask for an approval.
This commit is contained in:
SatoshiQaziMuhammed authored and GitHub committed 2026-11-12 22:32:28 +04:00
1 parent 9cfa765e61
commit 1914388d2b
15 files changed
+563 -38

No files matched your search

+161
View File
@@ -458,6 +458,19 @@ __metadata:
languageName: node
linkType: hard
"@gerrit0/mini-shiki@npm:^3.23.0":
version: 3.23.0
resolution: "@gerrit0/mini-shiki@npm:3.23.0"
dependencies:
"@shikijs/engine-oniguruma": "npm:^3.23.0"
"@shikijs/langs": "npm:^3.23.0"
"@shikijs/themes": "npm:^3.23.0"
"@shikijs/types": "npm:^3.23.0"
"@shikijs/vscode-textmate": "npm:^10.0.2"
checksum: 10/d44dac7c3f58ba136285b3c15c8a89eba120f7a493dddcf6178601ab8c0a5286da6a19515100297934288c41ae225f21013a4c395fe2f656b58f812dd13ccc1e
languageName: node
linkType: hard
"@humanfs/core@npm:^0.19.2":
version: 0.19.2
resolution: "@humanfs/core@npm:0.19.2"
@@ -2148,6 +2161,51 @@ __metadata:
languageName: node
linkType: hard
"@shikijs/engine-oniguruma@npm:^3.23.0":
version: 3.23.0
resolution: "@shikijs/engine-oniguruma@npm:3.23.0"
dependencies:
"@shikijs/types": "npm:3.23.0"
"@shikijs/vscode-textmate": "npm:^10.0.2"
checksum: 10/edd8983be86f6b055793813e80ecf31c3cefdd896f3742797ae03f2cbb9f467ac736c4b152d4a5c42dbd17da17d24ff798a15d37bcf6205d7f8cd8f44e2a11e0
languageName: node
linkType: hard
"@shikijs/langs@npm:^3.23.0":
version: 3.23.0
resolution: "@shikijs/langs@npm:3.23.0"
dependencies:
"@shikijs/types": "npm:3.23.0"
checksum: 10/115b1afb9eb4eb300eb68b146e442f7e6d196878798c5b9d75dd53a6ef1e1c3b27e325353a10973e3fa47d88630e937b8a3cf3b37b6eef80bf2aec3d51657bb3
languageName: node
linkType: hard
"@shikijs/themes@npm:^3.23.0":
version: 3.23.0
resolution: "@shikijs/themes@npm:3.23.0"
dependencies:
"@shikijs/types": "npm:3.23.0"
checksum: 10/741987380445b788aea6cc1e03492bc06950f1a0461edf45083bd226889c5ba78c7ed1af9724afacab7d6471777f0c0e8871577183dfb2cfbceb255663374835
languageName: node
linkType: hard
"@shikijs/types@npm:3.23.0, @shikijs/types@npm:^3.23.0":
version: 3.23.0
resolution: "@shikijs/types@npm:3.23.0"
dependencies:
"@shikijs/vscode-textmate": "npm:^10.0.2"
"@types/hast": "npm:^3.0.4"
checksum: 10/18b5703d445d53dd6782a3e2c7332009302c6c046f301d9cd99f1a26b9c8329b3e502b096894bffac61f78835c533827bab2ce78a39666ab87b78f8d7ca11f7b
languageName: node
linkType: hard
"@shikijs/vscode-textmate@npm:^10.0.2":
version: 10.1.0
resolution: "@shikijs/vscode-textmate@npm:10.1.0"
checksum: 10/7cf3d9c4c17979d680e670a985cd3e166a1e9960e6d648c3dc60299812040639a90b1dc9e7ab43bd24057a2913a122133fafde3d2cadeff515ebedca18a53fcd
languageName: node
linkType: hard
"@stylistic/eslint-plugin@npm:^5.10.0":
version: 5.10.0
resolution: "@stylistic/eslint-plugin@npm:5.10.0"
@@ -2345,6 +2403,15 @@ __metadata:
languageName: node
linkType: hard
"@types/hast@npm:^3.0.4":
version: 3.0.5
resolution: "@types/hast@npm:3.0.5"
dependencies:
"@types/unist": "npm:*"
checksum: 10/864a274e6e5ce0662de3bf984d804aea1f0e64eb4d5ffed27d9e832ee0002e76dfa18f1812a96b7cc24e2a9f40125ff2e47f73f7ab90c815840047c197d89635
languageName: node
linkType: hard
"@types/http-errors@npm:*":
version: 2.0.5
resolution: "@types/http-errors@npm:2.0.5"
@@ -2426,6 +2493,13 @@ __metadata:
languageName: node
linkType: hard
"@types/unist@npm:*":
version: 3.0.3
resolution: "@types/unist@npm:3.0.3"
checksum: 10/96e6453da9e075aaef1dc22482463898198acdc1eeb99b465e65e34303e2ec1e3b1ed4469a9118275ec284dc98019f63c3f5d49422f0e4ac707e5ab90fb3b71a
languageName: node
linkType: hard
"@types/ws@npm:^8.18.1":
version: 8.18.2
resolution: "@types/ws@npm:8.18.2"
@@ -4210,6 +4284,13 @@ __metadata:
languageName: node
linkType: hard
"entities@npm:^4.5.0":
version: 4.5.0
resolution: "entities@npm:4.5.0"
checksum: 10/ede2a35c9bce1aeccd055a1b445d41c75a14a2bb1cd22e242f20cf04d236cdcd7f9c859eb83f76885327bfae0c25bf03303665ee1ce3d47c5927b98b0e3e3d48
languageName: node
linkType: hard
"entities@npm:^6.0.0":
version: 6.0.1
resolution: "entities@npm:6.0.1"
@@ -6422,6 +6503,15 @@ __metadata:
languageName: node
linkType: hard
"linkify-it@npm:^5.0.2":
version: 5.0.2
resolution: "linkify-it@npm:5.0.2"
dependencies:
uc.micro: "npm:^2.0.0"
checksum: 10/1d23387319c15f2c3d41cdada0fc2edac73afb6083e967ee051afc826f7d8d9f920e287fb7c32679b4516f60e6450853dee2b4339d7d2f313222e4b9e5be1476
languageName: node
linkType: hard
"loader-runner@npm:^4.3.1":
version: 4.3.1
resolution: "loader-runner@npm:4.3.1"
@@ -6491,6 +6581,13 @@ __metadata:
languageName: node
linkType: hard
"lunr@npm:^2.3.9":
version: 2.3.9
resolution: "lunr@npm:2.3.9"
checksum: 10/f2f6db34c046f5a767782fe2454e6dd69c75ba3c5cf5c1cb9cacca2313a99c2ba78ff8fa67dac866fb7c4ffd5f22e06684793f5f15ba14bddb598b94513d54bf
languageName: node
linkType: hard
"madge@npm:^8.0.0":
version: 8.0.0
resolution: "madge@npm:8.0.0"
@@ -6564,6 +6661,22 @@ __metadata:
languageName: node
linkType: hard
"markdown-it@npm:^14.3.0":
version: 14.3.3
resolution: "markdown-it@npm:14.3.3"
dependencies:
argparse: "npm:^2.0.1"
entities: "npm:^4.5.0"
linkify-it: "npm:^5.0.2"
mdurl: "npm:^2.0.0"
punycode.js: "npm:^2.3.1"
uc.micro: "npm:^2.1.0"
bin:
markdown-it: bin/markdown-it.mjs
checksum: 10/ab96ec39766d59ed234304ef01108a13793b735dc1032a00f5bd89a20fb030f8c9305ac7b76f1f59a10257a4e456cdffd5f7c568e6ef9d99fe7f1fe2074395df
languageName: node
linkType: hard
"math-intrinsics@npm:^1.1.0":
version: 1.1.0
resolution: "math-intrinsics@npm:1.1.0"
@@ -6571,6 +6684,13 @@ __metadata:
languageName: node
linkType: hard
"mdurl@npm:^2.0.0":
version: 2.1.0
resolution: "mdurl@npm:2.1.0"
checksum: 10/b7db2c0aa0479e11c5454b8a6ae055326bd9180b83e58696f89e862b84a0f5c7c80e497be650f205c0807b4567f6ee3e09238a76c8f1217f1fd750a1f6f2146d
languageName: node
linkType: hard
"media-typer@npm:^1.1.0":
version: 1.1.1
resolution: "media-typer@npm:1.1.1"
@@ -7472,6 +7592,13 @@ __metadata:
languageName: node
linkType: hard
"punycode.js@npm:^2.3.1":
version: 2.3.1
resolution: "punycode.js@npm:2.3.1"
checksum: 10/f0e946d1edf063f9e3d30a32ca86d8ff90ed13ca40dad9c75d37510a04473340cfc98db23a905cc1e517b1e9deb0f6021dce6f422ace235c60d3c9ac47c5a16a
languageName: node
linkType: hard
"punycode@npm:^2.1.0, punycode@npm:^2.1.1, punycode@npm:^2.3.1":
version: 2.3.1
resolution: "punycode@npm:2.3.1"
@@ -7955,6 +8082,7 @@ __metadata:
"@pezkuwi/typegen": "workspace:*"
"@types/node": "npm:^22.10.5"
"@types/yargs": "npm:^17.0.35"
typedoc: "npm:0.28.20"
languageName: unknown
linkType: soft
@@ -8940,6 +9068,23 @@ __metadata:
languageName: node
linkType: hard
"typedoc@npm:0.28.20":
version: 0.28.20
resolution: "typedoc@npm:0.28.20"
dependencies:
"@gerrit0/mini-shiki": "npm:^3.23.0"
lunr: "npm:^2.3.9"
markdown-it: "npm:^14.3.0"
minimatch: "npm:^10.2.5"
yaml: "npm:^2.9.0"
peerDependencies:
typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x || 6.0.x
bin:
typedoc: bin/typedoc
checksum: 10/947172bc1bd85333aab1c6fb9dfe925e9184fcca6c6cd7310588e7d2135efcd4c412dcf9eb495c34522d3efdc793c2bc9e58d7ea06b1f917abffb7494ae04ec7
languageName: node
linkType: hard
"typescript@npm:5.5.4":
version: 5.5.4
resolution: "typescript@npm:5.5.4"
@@ -8960,6 +9105,13 @@ __metadata:
languageName: node
linkType: hard
"uc.micro@npm:^2.0.0, uc.micro@npm:^2.1.0":
version: 2.1.0
resolution: "uc.micro@npm:2.1.0"
checksum: 10/37197358242eb9afe367502d4638ac8c5838b78792ab218eafe48287b0ed28aaca268ec0392cc5729f6c90266744de32c06ae938549aee041fc93b0f9672d6b2
languageName: node
linkType: hard
"uglify-js@npm:^3.1.4":
version: 3.19.3
resolution: "uglify-js@npm:3.19.3"
@@ -9593,6 +9745,15 @@ __metadata:
languageName: node
linkType: hard
"yaml@npm:^2.9.0":
version: 2.9.1
resolution: "yaml@npm:2.9.1"
bin:
yaml: bin.mjs
checksum: 10/123c5e56a26f4962d3d5954971b2071a533d17041e00ae9ff6a5e634aed2503639bbdeea143b1610eac29613aad95a3a1d10f5fbda87b92203c039ce63934295
languageName: node
linkType: hard
"yargs-parser@npm:^21.1.1":
version: 21.1.1
resolution: "yargs-parser@npm:21.1.1"