Skip to content

feat(docs): drawn diagrams, logos and icons, scrollbars and tab titles - #312

Merged
Lexirieru merged 10 commits into
mainfrom
feat/docs-diagrams
Nov 13, 2026
Merged

Lexirieru merged 10 commits into
mainfrom
feat/docs-diagrams

Conversation

@AncungAulia

Copy link
Copy Markdown
Contributor

@Lexirieru Review pass on the docs site, done with Ancung (13 Nov).

What changed

  • How it works:
    • The Mermaid diagrams are replaced by SVG diagrams drawn in snippets/how-it-works.jsx: the parts, and one payment call by call.
    • There is a wide layout for desktop and a narrow one under 768 px.
    • Moving dots respect reduced motion.
    • The page has "## The parts" and "## One payment, call by call", so On this page lists both.
  • Tech stack:
    • Each technology's logo sits left of its name.
    • The empty column is removed.
    • The first table has a heading, so On this page lists it.
    • NEAR AI's black logo is inverted in dark mode.
  • The agent and Connectors: skill and app icons. Empty table headers are hidden.
  • Intro: it no longer repeats the subtitle, and the track names are plain text.
  • Text: "·" is removed (events.mdx).
  • Scrollbars: quiet, the same as apps/fe.
  • Tab titles:
    • Pages read "Page | HelloNear".
    • Mintlify's separator can't be configured, so title.js rewrites " - HelloNear".
  • Search: it only works on the deployed site. Local search needs mint login on your account, so it wasn't run.
  • apps/docs/CLAUDE.md is updated.

Tests (local)

  • mint validate: pass.
  • mint broken-links --check-anchors: no broken links.
  • Checked in mint dev at desktop and phone widths, light and dark.
  • Not run: integration or load tests. These are static docs.

🤖 Generated with Claude Code

AncungAulia and others added 10 commits November 13, 2026 09:20
Ancung (13 Nov): the system scrollbar on Windows had arrows and a grey
track. style.css (Mintlify loads every .css here) gives the docs the
same thin thumb as apps/fe and the status page, light and dark.

Tests: mint validate passes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- The first paragraph of the Introduction restated the subtitle (what
  a Mind is) word for word; it now starts from what a Mind does.
- The six tracks read as plain words, not as code chips.
- The events table separates stoppedBy's values with ';' instead of
  '·', like the rest of the site.

Tests: mint validate passes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ancung (13 Nov): the Mermaid flowchart shrank to unreadable text, worst
on phones. snippets/how-it-works.jsx draws both diagrams in SVG, like
the app's Mind Graph: rounded nodes, curved labelled links with dots
travelling along them (hidden for reduced motion), HelloNear's own
parts tinted lime (the colours are in style.css, light and dark).
- Architecture: left to right on desktop, with the backend's own
  calls in a bottom row whose links dip under the engine; redrawn top
  to bottom under 768 px.
- One payment, call by call: actor columns with arrows on desktop; a
  step list with who-to-whom chips on phones.
Same parts, arrows and steps as the Mermaid diagrams; nothing added.

Tests: mint validate passes. Playwright on mint dev, 1440 px light and
390 px dark: both drawings render, no sideways scroll, no page errors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ancung (13 Nov): labels of short arrows ran past the Owner column,
step numbers sat on either end of their arrow, and the two ways a
payment can go had no frame. Numbers now sit in a column of their own
on the left, every label is kept inside the drawing, each arrow starts
from a small dot, and the 'inside the policy' and 'otherwise' steps
sit in a dashed frame split between them, the refusal drawn in red.

Tests: mint validate passes; Playwright on mint dev at 1440 px dark:
no label leaves the drawing, no page errors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README's tech table keeps logos in a first column; the docs copy
had lost them, so that column was empty (Ancung, 13 Nov). The column
is gone and each technology's logo sits above its name, where the
README has one: NEAR, NEAR AI, Agent Market, OutLayer, Meteor, Mastra,
GLM, Composio, AgentMail, Telegram (copied into images/brands, as
Mintlify can't read outside apps/docs). Dark mode uses the white
versions; NEAR AI's black mark is inverted, as it has no white file.

Tests: mint validate passes; Playwright on mint dev at 1100 px light
and dark and 390 px: all ten logos load, no sideways scroll.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ancung (13 Nov): the logos stacked above the names; he wanted them on
the left. Each logo sits in a box of fixed width, so every name starts
at the same place (rows without a logo get a spacer), and a name that
wraps keeps that line (a hanging indent). On phones, where a logo
column doesn't fit, the logo stays above the name.

Tests: mint validate passes; Playwright at 1100 px light and dark and
390 px: the names line up, all ten logos load, no sideways scroll.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
'On this page' lists headings only, and the first table had none, so
it showed just 'How NEAR is used' (Ancung, 13 Nov). The table now sits
under 'What is used where'.

Tests: mint validate passes; the heading is in the rendered page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The README shows an icon in the first column of the skills and
connectors tables; the docs copy had lost them, leaving an empty
column (Ancung, 13 Nov). The agent's 34 skills and Connectors' 13
apps now show the README's own icons left of the names (copied into
images/skills and images/apps), in a narrow box that stays on the left
on phones; a row the README has no icon for keeps its place.
Two-column tables of labels and values (Introduction, The six tracks,
Contracts) had a blank header band; it is hidden.

Tests: mint validate passes; Playwright on mint dev: The agent (34
icons) and Connectors (13) at 1280 px light and dark and 390 px, the
header bands hidden on Introduction (1) and The six tracks (6), no
sideways scroll.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
'On this page' listed only the payment steps. The architecture
diagram now sits under 'The parts', and 'One payment, call by call'
is a top-level heading like it.

Tests: mint validate passes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ancung (13 Nov) wanted the docs' tabs to match the app's 'Chat |
HelloNear'. docs.json has no setting for Mintlify's ' - ' separator,
so title.js (Mintlify loads every .js here) rewrites it, again on each
page change. Only the tab changes; the server-sent title stays.

Tests: mint validate passes; Playwright on mint dev: 'Introduction |
HelloNear' on load, 'How it works | HelloNear' after a sidebar click,
'Tech stack | HelloNear' on a fresh load.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Lexirieru
Lexirieru merged commit 7035c58 into main Nov 13, 2026
2 checks passed
@Lexirieru

Copy link
Copy Markdown
Contributor

@AncungAulia Merged (7035c58) with Axel's approval. Mintlify rebuilt from main: https://hellonear.mintlify.site/how-it-works shows "One payment, call by call". docs.hellonear.xyz follows once its DNS is set.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants