Skip to content

docs(site): a Security page and the usage limits on docs.hellonear.xyz - #332

Merged
Lexirieru merged 1 commit into
mainfrom
docs/security-page
Nov 14, 2026
Merged

Lexirieru merged 1 commit into
mainfrom
docs/security-page

Conversation

@Lexirieru

Copy link
Copy Markdown
Contributor

The docs site said nothing about the team's security audit or the attack test from #330; only the README, JUDGE.md and docs/security/ did.

What changed

  • New page "Security: audited and attacked by the team" (apps/docs/security.mdx), under Concepts after Privacy. Sliced from the README's "Security audit by the team" section: what was reviewed, the threat model, every attack tried against the hosted API and its answer, the IPv6 gap that was found and fixed, what is still missing, two curl commands a reader can run, and links to docs/security/ on GitHub. It keeps the sentence that no outside party has audited HelloNear.
  • Hackathon phase page: the README's "Usage limits" row.
  • docs.json (navigation) and apps/docs/CLAUDE.md.

Checks (local)

  • bunx mint@4.2.1184 validate: passed.
  • bunx mint@4.2.1184 broken-links --check-anchors: no broken links.
  • Not done: looking at the rendered page in a browser.
  • Docs only; no code, so no integration or load tests were run.

@Lin1er @AncungAulia @Nabil-Aufa FYI. @AncungAulia the page uses plain Markdown tables, nothing new in style.css.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Q5ZrzK8une3S2YyhDG746e

#330)

The docs site said nothing about the team's security audit or the
attack test. New page "Security" under Concepts, sliced from the
README's "Security audit by the team" section with links to
docs/security/ on GitHub and two commands a reader can run. It keeps the
sentence that no outside party has audited HelloNear. The Hackathon
phase page gets the README's "Usage limits" row.

Checks: mint validate passed; mint broken-links --check-anchors found
no broken links. Docs only.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Q5ZrzK8une3S2YyhDG746e
@Lexirieru
Lexirieru merged commit 4ddf8c8 into main Nov 14, 2026
2 checks passed
@Lin1er

Lin1er commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Live on the hosted demo: main 4ddf8c8 (automatic deploy after the merge).

  • Before: b5197a0, and the box matched git at that revision. CI: passed: Mintlify Deployment,mintlify.
  • GET /v1/health → {"ok":true,"engine":true,"revision":"4ddf8c8"}. No rollback.
  • Rollback target: b5197a0 (/opt/hellonear/release-old).

@Lexirieru

Copy link
Copy Markdown
Contributor Author

Merged as 4ddf8c8 with Axel's approval, and both deploys have run.

  • Docs site: https://docs.hellonear.xyz/security shows the new page ("Security: audited and attacked by the team"), and the Hackathon phase page has the "Usage limits" row. Checked through the pages' Markdown (/security.md, /hackathon-phase.md), not in a browser.
  • Hosted demo: GET /v1/health → {"ok":true,"engine":true,"revision":"4ddf8c8"}, the same on a second check 10 s later. Docs only, so nothing that runs changed.

Follow-up: #333 removes the day-by-day dates from the security sections (README, JUDGE.md and this page).

@Lexirieru (author) @Lin1er @AncungAulia @Nabil-Aufa FYI.

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