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
2 changes: 1 addition & 1 deletion apps/docs/CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The docs site, **docs.hellonear.xyz**, a **Mintlify** project (Starter plan) con
## How it works

- **Pages:** one `.mdx` file per page in this folder (frontmatter `title`, `description`), `index.mdx` is the introduction. Most text was sliced from `README.md` and `docs/api-contract.md` §3 on 13 Nov; it does not update by itself, so change the page when the README section changes. Never invent features, numbers or claims; link proof (tx, report, file) where you can. No en or em dashes. MDX: `{`, `}` and `<` outside code are JSX, keep them in backticks.
- **`docs.json`** is the whole configuration: theme, Stone & Lime colors (primary `#3E5C00`, lime `#D8F04A` in dark mode), logo (`logo/`, copied from `design/logo/`), favicon, navbar (Trust, Status, GitHub) and navigation. A new page must be added to `navigation` or it does not show in the sidebar.
- **`docs.json`** is the whole configuration: theme, Stone & Lime colors (primary `#3E5C00`, lime `#D8F04A` in dark mode), logo (`logo/`, copied from `design/logo/`), favicon, navbar (Trust, Status, GitHub), footer socials (X `@hellonearai`, GitHub) and navigation. A new page must be added to `navigation` or it does not show in the sidebar.
- **API reference:** the **Endpoints** tab is generated by Mintlify from `docs/openapi.json` on `main`, referenced by its raw GitHub URL. Mintlify refuses paths outside this folder (`../` is not allowed), and a copy here would drift from the one source the backend maintains. So an endpoint change shows on the site once it is on `main` and Mintlify rebuilds (any push that changes `apps/docs`, or a manual redeploy in the dashboard). Each endpoint has a playground that calls `servers` from the spec (the hosted API). `api-reference.mdx` is the prose page in the sidebar.
- **For agents, from Mintlify itself:** `/llms.txt`, `/llms-full.txt`, every page as Markdown at `<page>.md`, `/skill.md` and a search MCP server at `/mcp`. Nothing to maintain here.
- **Deploys:** Mintlify's GitHub app watches `main`. Git settings in the Mintlify dashboard: repository `Hellonear-AI/hellonear`, branch `main`, "docs.json is in a subdirectory" on, path `/apps/docs`. Custom domain `docs.hellonear.xyz` is set in Mintlify's Domain setup; its `CNAME` in the `hellonear.xyz` Cloudflare zone (DNS only) is on the box owner's side (James), with Axel's approval. Pull requests get a Mintlify preview if the GitHub app is allowed to comment.
Expand Down
1 change: 1 addition & 0 deletions apps/docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
},
"footer": {
"socials": {
"x": "https://x.com/hellonearai",
"github": "https://github.com/Hellonear-AI/hellonear"
}
}
Expand Down
3 changes: 3 additions & 0 deletions apps/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ Built at **NEAR HACKATHON** (1 to 14 Nov 2026) for six tracks: security, privacy
| Landing page | [hellonear.xyz](https://hellonear.xyz) |
| API (NEAR testnet) | [api.hellonear.xyz/v1/health](https://api.hellonear.xyz/v1/health) |
| Status, checked every 5 minutes | [status.hellonear.xyz](https://status.hellonear.xyz) |
| Docs (this site; `llms.txt` and an MCP server for agents) | [docs.hellonear.xyz](https://docs.hellonear.xyz) |
| Trust Center, each claim linked to its proof | [trust.hellonear.xyz](https://trust.hellonear.xyz) |
| Mind registry contract | [`hellonear-registry.testnet`](https://testnet.nearblocks.io/address/hellonear-registry.testnet?tab=contract) (v0.3.0, source verified) |
| Swarm auction contract | [`auction.hellonear-swarm.testnet`](https://testnet.nearblocks.io/address/auction.hellonear-swarm.testnet?tab=contract) (source verified) |
| OpenAPI spec | [openapi.json](https://github.com/Hellonear-AI/hellonear/blob/main/docs/openapi.json), rendered in the Endpoints tab (see the [API reference](/api-reference)) |
| Repository | [github.com/Hellonear-AI/hellonear](https://github.com/Hellonear-AI/hellonear) |
| X | [@hellonearai](https://x.com/hellonearai) |

## The problem

Expand Down
Loading