Skip to content

Commit 4f7bfdb

Browse files
notrabgreptile-apps[bot]lightwalker-eth
authored
add ensnode api docs changeset config (#1530)
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com>
1 parent b25605b commit 4f7bfdb

6 files changed

Lines changed: 4654 additions & 107 deletions

File tree

.changeset/bright-foxes-smile.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@docs/mintlify": patch
3+
---
4+
5+
Introduced new documentation site at docs.ensnode.io powered by Mintlify for browsing API endpoints, and make requests using the API Playground.

.changeset/clever-planes-march.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@docs/mintlify": patch
3+
---
4+
5+
Added OpenAPI documentation for ENSNode APIs. The interactive API reference allows developers to explore and test API endpoints directly from the documentation.

.changeset/config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"@ensnode/shared-configs",
2222
"@docs/ensnode",
2323
"@docs/ensrainbow",
24+
"@docs/mintlify",
2425
"@namehash/ens-referrals",
2526
"@namehash/namehash-ui"
2627
]

docs/docs.ensnode.io/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@
1818
cd ensnode/docs/docs.ensnode.io
1919
```
2020

21-
3. Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify):
21+
3. Install dependencies:
2222

2323
```bash
24-
pnpm add -g mintlify
24+
pnpm install
2525
```
2626

2727
4. Start the local development server:
2828

2929
```bash
30-
mintlify dev
30+
pnpm dev
3131
```
3232

3333
5. Open [http://localhost:3000](http://localhost:3000) in your browser

docs/docs.ensnode.io/package.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"name": "@docs/mintlify",
3+
"version": "1.5.0",
4+
"private": true,
5+
"type": "module",
6+
"description": "ENSNode's Mintlify docs",
7+
"license": "MIT",
8+
"repository": {
9+
"type": "git",
10+
"url": "git+https://github.com/namehash/ensnode.git",
11+
"directory": "docs/docs.ensnode.io"
12+
},
13+
"homepage": "https://github.com/namehash/ensnode/tree/main/docs/docs.ensnode.io",
14+
"scripts": {
15+
"dev": "mintlify dev"
16+
},
17+
"devDependencies": {
18+
"mintlify": "^4.1.0"
19+
},
20+
"packageManager": "pnpm@10.28.0"
21+
}

0 commit comments

Comments
 (0)