Skip to content
Merged
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
```
30 changes: 29 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,35 @@
"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",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Replace staging OpenAPI URL with public spec

This API reference entry points to a *.stage-crypto.worldcoin.org OpenAPI document, which is not publicly readable (returns 403 without internal access), so Mint-powered endpoint docs will not render for external users and can also fail in non-internal build environments. Please switch these OpenAPI sources to publicly accessible/prod specs (or checked-in local spec files) before exposing them in navigation.

Useful? React with 👍 / 👎.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we still only have this service in staging

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not true

"pages": [
"POST /inclusion-proof",
"POST /packed-account",
"POST /signature-nonce",
"POST /authenticator-pubkeys"
]
},
{
"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/poh-issuer",
"world-id/reference/contracts",
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",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i believe mintlify has spellcheck built-in that runs on the CI as well but we haven't configured it.

"check-links": "mint broken-links"
},
"keywords": [],
"author": "",
"license": "MIT",
"packageManager": "pnpm@10.13.1",
"dependencies": {
"mint": "^4.2.367"
},
"devDependencies": {
"cspell": "^9"
}
}
Loading