From 118cea704d840da3483b8f64ceb932445affa7d4 Mon Sep 17 00:00:00 2001 From: Lexirieru Date: Fri, 13 Nov 2026 13:31:35 +0700 Subject: [PATCH] docs(docs): the intro's Live now lists Docs, the Trust Center and X; X in the footer Matches the README's Live now (#315), asked by Axel on 13 Nov. The footer socials gain X (@hellonearai) next to GitHub. Checks: mint validate passed, mint broken-links --check-anchors found none. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Q5ZrzK8une3S2YyhDG746e --- apps/docs/CLAUDE.md | 2 +- apps/docs/docs.json | 1 + apps/docs/index.mdx | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/apps/docs/CLAUDE.md b/apps/docs/CLAUDE.md index 0c85564..888b618 100644 --- a/apps/docs/CLAUDE.md +++ b/apps/docs/CLAUDE.md @@ -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 `.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. diff --git a/apps/docs/docs.json b/apps/docs/docs.json index fabc910..adb1c91 100644 --- a/apps/docs/docs.json +++ b/apps/docs/docs.json @@ -113,6 +113,7 @@ }, "footer": { "socials": { + "x": "https://x.com/hellonearai", "github": "https://github.com/Hellonear-AI/hellonear" } } diff --git a/apps/docs/index.mdx b/apps/docs/index.mdx index b089ab9..cc40f04 100644 --- a/apps/docs/index.mdx +++ b/apps/docs/index.mdx @@ -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