Skip to content

docs: integrate architecture diagrams and polish marketing surfaces#35

Merged
salazarsebas merged 9 commits into
mainfrom
docs/integrate-architecture-diagrams
Jun 23, 2026
Merged

docs: integrate architecture diagrams and polish marketing surfaces#35
salazarsebas merged 9 commits into
mainfrom
docs/integrate-architecture-diagrams

Conversation

@salazarsebas

Copy link
Copy Markdown
Member

Summary

Replaces inline Mermaid blocks in the architecture document with pre-rendered SVG/PNG exports, adds a reproducible Python render pipeline, and refreshes the marketing site with a content hub, a hero account analyzer, and several small UI/backend fixes.

Motivation

Inline Mermaid diagrams render inconsistently across GitHub, Mintlify, and local previews. Exporting them to versioned assets gives the architecture doc and README a single, stable visual source. The marketing changes make it easier for visitors to jump straight into analysis and discover videos alongside blog posts.

Changes

Architecture diagrams

  • Add scripts/diagrams/ — nine diagram scripts, shared _style.py, and render-all.py
  • Commit rendered SVG + 2× PNG exports under docs/diagrams/output/
  • Replace all nine inline Mermaid blocks in docs/architecture.md with image embeds
  • Update docs/diagrams/README.md with the export workflow and output index
  • Ignore **/__pycache__/ in .gitignore

Documentation

  • Restructure README.md around the system architecture diagram and tighter copy on reserves, manual close friction, and the trust model
  • Normalize punctuation (-) across docs and UI strings

Marketing UI

  • HeroAccountInput — inline address field on the landing page that routes to /mainnet/analyze?source=…
  • /content hub — videos and blog posts in one place; nav/footer link renamed from "Blog" to "Content" (existing /blog routes remain active)
  • Calendar heatmap — fix stellar color levels via inline styles (Tailwind JIT does not generate bg-stellar/x modifiers); fixed-height detail panel; hover state survives cursor travel to the panel
  • Playground — "Run {mode} again" primary action plus a secondary "Choose a different mode" reset

Backend

  • recordMerge — consolidate deduplication, global counters, recent list, and daily counter into a single Lua eval, preventing partial KV state on failure

Regenerating diagrams

python scripts/diagrams/render-all.py

Requires Python with the diagram dependencies used by the scripts (see scripts/diagrams/_style.py). Re-run after editing any scripts/diagrams/*.py source, then commit the updated files in docs/diagrams/output/.

Test plan

  • bun type-check
  • bun lint
  • bun test (unit tests pass; Playwright specs excluded per project convention)
  • Visual check: landing hero input validates G… addresses and navigates correctly
  • Visual check: /content renders video cards and blog post list
  • Visual check: stats calendar heatmap colors and hover panel on /stats
  • Visual check: architecture doc and README render diagram embeds on GitHub/Mintlify

Commit history

Commit Description
fix(backend) Atomically record merge counters in Lua script
fix(ui) Stabilize calendar heatmap colors and hover
feat(ui) Add playground mode reset after completion
feat(ui) Add hero account analyzer on landing page
feat(ui) Add content hub with videos and blog posts
chore(diagrams) Add Python render pipeline
docs(diagrams) Embed rendered SVG exports in architecture doc
docs Restructure README around architecture overview
docs Format punctuation across docs and UI strings

Consolidate deduplication, global counters, recent list, and daily
counter into a single Lua eval so a KV failure cannot leave partial
state.
Use inline styles for stellar color levels since Tailwind JIT does not
generate bg-stellar opacity modifiers. Fix hover panel layout jump and
preserve selection when moving the cursor to the detail panel.
Add a secondary action to return to mode selection and label the rerun
button with the active scenario name.
Add an inline address input that routes directly to mainnet analyze and
refresh the hero label styling.
Introduce /content as the marketing hub for videos and articles, update
nav and footer links, and normalize page title punctuation.
Add reproducible diagram scripts with shared styling and a render-all
entrypoint. Ignore Python bytecode artifacts.
Replace inline Mermaid blocks with pre-rendered SVG and PNG exports and
document the export workflow in docs/diagrams/README.md.
Reorganize the project README with the system architecture diagram and
tighter copy on reserves, manual close friction, and the trust model.
@vercel

vercel Bot commented Jun 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
lumenwipe Ready Ready Preview, Comment Jun 23, 2026 4:56am

@salazarsebas salazarsebas merged commit 8add422 into main Jun 23, 2026
4 checks passed
@salazarsebas salazarsebas deleted the docs/integrate-architecture-diagrams branch June 23, 2026 04:58
@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lumenwipe 🔴 Failed Jun 23, 2026, 4:58 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

1 participant