Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,9 @@ developer-docs repository

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview the documentation changes locally. To install, use the following command

```
npm i -g mint
```

Run the following command at the root of your documentation (where docs.json is)

```
mint dev
```

#### Troubleshooting

- It the dev environment isn't running - Run `mint install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
pnpm i
pnpm dev
```
31 changes: 29 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@
"groups": [
{
"group": "Introduction",
"pages": ["world-id/concepts"]
"pages": ["world-id/index", "world-id/concepts"]
},
{
"group": "ID Kit",
Expand All @@ -166,7 +166,34 @@
"group": "Technical Reference",
"pages": [
"world-id/reference/idkit",
"world-id/reference/api",
"world-id/reference/authenticator",
{
"group": "API References",
"pages": [
{
"group": "Indexer",
"openapi": "https://world-id-indexer.stage-crypto.worldcoin.org/openapi.json",
"pages": [
"POST /inclusion-proof",
"POST /packed-account",
"POST /signature-nonce"
]
},
{
"group": "Gateway",
"openapi": "https://world-id-gateway.stage-crypto.worldcoin.org/openapi.json",
"pages": [
"POST /create-account",
"POST /insert-authenticator",
"POST /update-authenticator",
"POST /remove-authenticator",
"POST /recover-account",
"GET /is-valid-root",
"GET /status/{id}"
]
}
]
},
"world-id/reference/sign-in",
"world-id/reference/contracts",
"world-id/reference/contract-deployments",
Expand Down
21 changes: 21 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "world-docs",
"version": "0.0.1",
"description": "",
"scripts": {
"mint": "mint",
"dev": "mint dev",
"spellcheck": "cspell '**/*.{md,mdx,json,yml,yaml,ts,tsx,js,jsx}' --no-progress",
"check-links": "mint broken-links"
},
"keywords": [],
"author": "",
"license": "MIT",
"packageManager": "pnpm@10.13.1",
"dependencies": {
"mint": "^4"
},
"devDependencies": {
"cspell": "^9"
}
}
Loading