Skip to content

Add API docs #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Dec 8, 2023
Merged

Add API docs #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
787de6a
Add API docs
davidkpiano Dec 7, 2023
221196e
Add API docs
davidkpiano Dec 7, 2023
342886a
Add postinstall script to install dependencies in
davidkpiano Dec 7, 2023
65c17d7
Update postinstall script
mellson Dec 8, 2023
bd65fd5
untrack xstate
mellson Dec 8, 2023
8cf3105
sort packages so we always have xstate first
mellson Dec 8, 2023
7efe234
script fiddling
mellson Dec 8, 2023
a953d78
Revert "untrack xstate"
mellson Dec 8, 2023
9d48f03
update xstate
mellson Dec 8, 2023
9c9f9b4
Merge branch 'main' into davidkpiano/api-docs
mellson Dec 8, 2023
ad1b90a
logo links to docs when inside docs
mellson Dec 8, 2023
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
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "xstate"]
path = xstate
url = https://github.com/statelyai/xstate
32 changes: 32 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,32 @@ const config = {
},
},
],
[
'docusaurus-plugin-typedoc-api',
{
disableVersioning: true,
projectRoot: `${__dirname}/xstate`,
packages: [
{ path: 'packages/core', slug: 'xstate' },
{ path: 'packages/xstate-graph', slug: '@xstate/graph' },
{ path: 'packages/xstate-react', slug: '@xstate/react' },
{ path: 'packages/xstate-solid', slug: '@xstate/solid' },
{ path: 'packages/xstate-svelte', slug: '@xstate/svelte' },
{ path: 'packages/xstate-test', slug: '@xstate/test' },
{ path: 'packages/xstate-vue', slug: '@xstate/vue' },
],
// We're sorting the packages here to ensure that the "xstate" package is first
sortPackages: (p1, p2) => {
if (p1.packageName === 'xstate') {
return -1;
} else if (p2.packageName === 'xstate') {
return 1;
} else {
return p1.packageName.localeCompare(p2.packageName);
}
},
},
],
async function tailwindPlugin(context, options) {
return {
name: 'docusaurus-tailwindcss',
Expand Down Expand Up @@ -178,13 +204,19 @@ const config = {
alt: 'Stately',
src: '/logo-black.svg',
srcDark: '/logo-white-nobg.svg',
href: '/docs',
},
items: [
{
type: 'search',
position: 'right',
},
{ to: '/docs', label: 'Docs', position: 'right' },
{
to: '/api',
label: 'API',
position: 'right',
},
{
href: 'https://stately.ai/registry/projects',
label: 'Studio',
Expand Down
2 changes: 2 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "0.1.0",
"repository": "https://github.com/statelyai/docs",
"scripts": {
"postinstall": "git submodule update --init --remote && cd xstate && yarn",
"docusaurus": "docusaurus",
"remark:once": "yarn remark --quiet --frail docs/**/* versioned_docs/**/*",
"remark:watch": "yarn remark --quiet --frail --watch docs/**/* versioned_docs/**/*",
Expand Down Expand Up @@ -61,6 +62,7 @@
"@docusaurus/types": "^3.0.1",
"@fec/remark-a11y-emoji": "^4.0.2",
"concurrently": "^8.2.2",
"docusaurus-plugin-typedoc-api": "^4.0.1",
"dotenv": "^16.3.1",
"remark-cli": "^12.0.0",
"remark-validate-links": "^13.0.0",
Expand Down
5 changes: 5 additions & 0 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ const sidebars = {
},
'templates',
'cheatsheet',
{
type: 'link',
href: '/api',
label: 'API',
},
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion xstate
Open in desktop
Submodule xstate updated 20 files
+33 −0 packages/core/CHANGELOG.md
+1 −1 packages/core/package.json
+14 −14 packages/core/src/index.ts
+21 −4 packages/core/src/interpreter.ts
+9 −1 packages/core/src/spawn.ts
+36 −0 packages/core/src/toPromise.ts
+3 −1 packages/core/src/types.ts
+53 −0 packages/core/test/interpreter.test.ts
+137 −0 packages/core/test/toPromise.test.ts
+47 −0 packages/core/test/types.test.ts
+2 −2 packages/xstate-graph/package.json
+2 −2 packages/xstate-immer/package.json
+2 −2 packages/xstate-inspect/package.json
+2 −2 packages/xstate-react/package.json
+3 −9 packages/xstate-solid/package.json
+2 −1 packages/xstate-solid/src/createImmutable.ts
+46 −0 packages/xstate-solid/test/useMachine.test.tsx
+2 −2 packages/xstate-svelte/package.json
+2 −2 packages/xstate-test/package.json
+2 −2 packages/xstate-vue/package.json
93 changes: 89 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1872,7 +1872,7 @@
utility-types "^3.10.0"
webpack "^5.88.1"

"@docusaurus/[email protected]":
"@docusaurus/[email protected]", "@docusaurus/plugin-content-docs@^3.0.0":
version "3.0.1"
resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-docs/-/plugin-content-docs-3.0.1.tgz#d9b1884562186573d5c4521ac3546b68512c1126"
integrity sha512-dRfAOA5Ivo+sdzzJGXEu33yAtvGg8dlZkvt/NEJ7nwi1F2j4LEdsxtfX2GKeETB2fP6XoGNSQnFXqa2NYGrHFg==
Expand Down Expand Up @@ -2090,7 +2090,7 @@
resolved "https://registry.yarnpkg.com/@docusaurus/tsconfig/-/tsconfig-3.0.1.tgz#170f230c34ff12e55995bd7e9f1f21db33035d8f"
integrity sha512-hT2HCdNE3pWTzXV/7cSsowfmaOxXVOTFOXmkqaYjBWjaxjJ3FO0nHbdJ8rF6Da7PvWmIPbUekdP5gep1XCJ7Vg==

"@docusaurus/[email protected]", "@docusaurus/types@^3.0.1":
"@docusaurus/[email protected]", "@docusaurus/types@^3.0.0", "@docusaurus/types@^3.0.1":
version "3.0.1"
resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-3.0.1.tgz#4fe306aa10ef7c97dbc07588864f6676a40f3b6f"
integrity sha512-plyX2iU1tcUsF46uQ01pAd4JhexR7n0iiQ5MSnBFX6M6NSJgDYdru/i1/YNPKOnQHBoXGLHv0dNT6OAlDWNjrg==
Expand Down Expand Up @@ -2136,7 +2136,7 @@
js-yaml "^4.1.0"
tslib "^2.6.0"

"@docusaurus/[email protected]":
"@docusaurus/[email protected]", "@docusaurus/utils@^3.0.0":
version "3.0.1"
resolved "https://registry.yarnpkg.com/@docusaurus/utils/-/utils-3.0.1.tgz#c64f68980a90c5bc6d53a5b8f32deb9026b1e303"
integrity sha512-TwZ33Am0q4IIbvjhUOs+zpjtD/mXNmLmEgeTGuRq01QzulLHuPhaBTTAC/DHu6kFx3wDgmgpAlaRuCHfTcXv8g==
Expand Down Expand Up @@ -3082,6 +3082,11 @@
resolved "https://registry.yarnpkg.com/@ungap/structured-clone/-/structured-clone-1.2.0.tgz#756641adb587851b5ccb3e095daf27ae581c8406"
integrity sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==

"@vscode/codicons@^0.0.35":
version "0.0.35"
resolved "https://registry.yarnpkg.com/@vscode/codicons/-/codicons-0.0.35.tgz#7424a647f39c6e71c86c1edf12bfc27196c8fba1"
integrity sha512-7iiKdA5wHVYSbO7/Mm0hiHD3i4h+9hKUe1O4hISAe/nHhagMwb2ZbFC8jU6d7Cw+JNT2dWXN2j+WHbkhT5/l2w==

"@webassemblyjs/[email protected]":
version "1.11.1"
resolved "https://registry.yarnpkg.com/@webassemblyjs/ast/-/ast-1.11.1.tgz#2bfd767eae1a6996f432ff7e8d7fc75679c0b6a7"
Expand Down Expand Up @@ -3503,6 +3508,11 @@ ansi-regex@^6.0.1:
resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a"
integrity sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==

ansi-sequence-parser@^1.1.0:
version "1.1.1"
resolved "https://registry.yarnpkg.com/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz#e0aa1cdcbc8f8bb0b5bca625aac41f5f056973cf"
integrity sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==

ansi-styles@^3.2.1:
version "3.2.1"
resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d"
Expand Down Expand Up @@ -4740,6 +4750,19 @@ docusaurus-plugin-api-extractor@^2.0.4:
prettier "^2.5.1"
standard-markdown-documenter "0.2.2"

docusaurus-plugin-typedoc-api@^4.0.1:
version "4.0.1"
resolved "https://registry.yarnpkg.com/docusaurus-plugin-typedoc-api/-/docusaurus-plugin-typedoc-api-4.0.1.tgz#c4051a112608046e7717d7238689c173b4a48d2b"
integrity sha512-mHHqvSz3qEPj1IPYa7Td75CWpWsVd6O0Fwex6XfZgj5kUDjeFCw50arc7j9n8xjXcqC1iIQ1ppz+AWwfSRZ0Kw==
dependencies:
"@docusaurus/plugin-content-docs" "^3.0.0"
"@docusaurus/types" "^3.0.0"
"@docusaurus/utils" "^3.0.0"
"@vscode/codicons" "^0.0.35"
marked "^9.1.5"
marked-smartypants "^1.1.3"
typedoc "^0.25.3"

dom-converter@^0.2.0:
version "0.2.0"
resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768"
Expand Down Expand Up @@ -6530,6 +6553,11 @@ json5@^2.1.2:
resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.1.tgz#655d50ed1e6f95ad1a3caababd2b0efda10b395c"
integrity sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==

jsonc-parser@^3.2.0:
version "3.2.0"
resolved "https://registry.yarnpkg.com/jsonc-parser/-/jsonc-parser-3.2.0.tgz#31ff3f4c2b9793f89c67212627c51c6394f88e76"
integrity sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==

jsonfile@^4.0.0:
version "4.0.0"
resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
Expand Down Expand Up @@ -6735,6 +6763,11 @@ lucide-react@^0.293.0:
resolved "https://registry.yarnpkg.com/lucide-react/-/lucide-react-0.293.0.tgz#02703dbcc56bb38779f4e576cc03be8cc0046fcc"
integrity sha512-g3AN0EYITCpAjNgLHrKrFWvIJzZy0Y9OPBaonyKw1cM+nZE6piOM+TiuQdYfha7oa76TMiDaWXQHE44CEqsrzw==

lunr@^2.3.9:
version "2.3.9"
resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.9.tgz#18b123142832337dd6e964df1a5a7707b25d35e1"
integrity sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==

markdown-extensions@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/markdown-extensions/-/markdown-extensions-2.0.0.tgz#34bebc83e9938cae16e0e017e4a9814a8330d3c4"
Expand All @@ -6745,6 +6778,23 @@ markdown-table@^3.0.0:
resolved "https://registry.yarnpkg.com/markdown-table/-/markdown-table-3.0.3.tgz#e6331d30e493127e031dd385488b5bd326e4a6bd"
integrity sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==

marked-smartypants@^1.1.3:
version "1.1.5"
resolved "https://registry.yarnpkg.com/marked-smartypants/-/marked-smartypants-1.1.5.tgz#1ea079764ce47c963843c2f77b5a6cb85664f409"
integrity sha512-gp+IpDsthwcXJ/sWT8si7dGWL6Diag3Iy4+OOoMZnhjFAox9z77cWfqQUmwY9oP9XACWZeiBXvWW1TOjTbvwAw==
dependencies:
smartypants "^0.2.2"

marked@^4.3.0:
version "4.3.0"
resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3"
integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==

marked@^9.1.5:
version "9.1.6"
resolved "https://registry.yarnpkg.com/marked/-/marked-9.1.6.tgz#5d2a3f8180abfbc5d62e3258a38a1c19c0381695"
integrity sha512-jcByLnIFkd5gSXZmjNvS1TlmRhCXZjIzHYlaGkPlLIekG55JDR2Z4va9tZwCiP+/RDERiNhMOFu01xd6O5ct1Q==

mdast-util-directive@^3.0.0:
version "3.0.0"
resolved "https://registry.yarnpkg.com/mdast-util-directive/-/mdast-util-directive-3.0.0.tgz#3fb1764e705bbdf0afb0d3f889e4404c3e82561f"
Expand Down Expand Up @@ -7513,7 +7563,7 @@ minimatch@^5.0.1:
dependencies:
brace-expansion "^2.0.1"

minimatch@^9.0.0, minimatch@^9.0.1:
minimatch@^9.0.0, minimatch@^9.0.1, minimatch@^9.0.3:
version "9.0.3"
resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.3.tgz#a6e00c3de44c3a542bfaae70abfc22420a6da825"
integrity sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==
Expand Down Expand Up @@ -9391,6 +9441,16 @@ shelljs@^0.8.5:
interpret "^1.0.0"
rechoir "^0.6.2"

shiki@^0.14.1:
version "0.14.5"
resolved "https://registry.yarnpkg.com/shiki/-/shiki-0.14.5.tgz#375dd214e57eccb04f0daf35a32aa615861deb93"
integrity sha512-1gCAYOcmCFONmErGTrS1fjzJLA7MGZmKzrBNX7apqSwhyITJg2O102uFzXUeBxNnEkDA9vHIKLyeKq0V083vIw==
dependencies:
ansi-sequence-parser "^1.1.0"
jsonc-parser "^3.2.0"
vscode-oniguruma "^1.7.0"
vscode-textmate "^8.0.0"

side-channel@^1.0.4:
version "1.0.4"
resolved "https://registry.yarnpkg.com/side-channel/-/side-channel-1.0.4.tgz#efce5c8fdc104ee751b25c58d4290011fa5ea2cf"
Expand Down Expand Up @@ -9451,6 +9511,11 @@ slash@^4.0.0:
resolved "https://registry.yarnpkg.com/slash/-/slash-4.0.0.tgz#2422372176c4c6c5addb5e2ada885af984b396a7"
integrity sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==

smartypants@^0.2.2:
version "0.2.2"
resolved "https://registry.yarnpkg.com/smartypants/-/smartypants-0.2.2.tgz#ad7124d8eb9ab437906db1cd7bd7aaf49e5d9a42"
integrity sha512-TzobUYoEft/xBtb2voRPryAUIvYguG0V7Tt3de79I1WfXgCwelqVsGuZSnu3GFGRZhXR90AeEYIM+icuB/S06Q==

sockjs@^0.3.24:
version "0.3.24"
resolved "https://registry.yarnpkg.com/sockjs/-/sockjs-0.3.24.tgz#c9bc8995f33a111bea0395ec30aa3206bdb5ccce"
Expand Down Expand Up @@ -9973,6 +10038,16 @@ typedarray@^0.0.6:
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==

typedoc@^0.25.3:
version "0.25.4"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.4.tgz#5c2c0677881f504e41985f29d9aef0dbdb6f1e6f"
integrity sha512-Du9ImmpBCw54bX275yJrxPVnjdIyJO/84co0/L9mwe0R3G4FSR6rQ09AlXVRvZEGMUg09+z/usc8mgygQ1aidA==
dependencies:
lunr "^2.3.9"
marked "^4.3.0"
minimatch "^9.0.3"
shiki "^0.14.1"

typescript@^5.3.2:
version "5.3.2"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.2.tgz#00d1c7c1c46928c5845c1ee8d0cc2791031d4c43"
Expand Down Expand Up @@ -10364,6 +10439,16 @@ vfile@^6.0.0, vfile@^6.0.1:
unist-util-stringify-position "^4.0.0"
vfile-message "^4.0.0"

vscode-oniguruma@^1.7.0:
version "1.7.0"
resolved "https://registry.yarnpkg.com/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz#439bfad8fe71abd7798338d1cd3dc53a8beea94b"
integrity sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==

vscode-textmate@^8.0.0:
version "8.0.0"
resolved "https://registry.yarnpkg.com/vscode-textmate/-/vscode-textmate-8.0.0.tgz#2c7a3b1163ef0441097e0b5d6389cd5504b59e5d"
integrity sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==

walk-up-path@^3.0.1:
version "3.0.1"
resolved "https://registry.yarnpkg.com/walk-up-path/-/walk-up-path-3.0.1.tgz#c8d78d5375b4966c717eb17ada73dbd41490e886"
Expand Down