Skip to content

Define architectural pattern to the developed project and mentioned w…#9

Closed
imchintoo wants to merge 1 commit into
mainfrom
feature/visualise-architect-report
Closed

Define architectural pattern to the developed project and mentioned w…#9
imchintoo wants to merge 1 commit into
mainfrom
feature/visualise-architect-report

Conversation

@imchintoo

Copy link
Copy Markdown
Owner

What changed

  1. Design system redesign — full dark-theme rebrand of the generated docs site
    to match the Figma Make reference (jsdoc-scribe branding, not Hundi): color
    tokens, fonts (Geist/IBM Plex Sans/JetBrains Mono), SVG health gauge, restyled
    stat cards/badges/sidebar/topnav, all reusing existing DOM contracts.

  2. Architecture tree redesign — "HOW IT'S ORGANIZED" now renders as a real
    indented tree with colored, recursive badges per directory level (folders,
    TypeScript, JavaScript, CSS, other). Sidebar widened 192px → 224px; detail-page
    spacing polish.

  3. Architectural pattern detection (new)gen-docs now scans the source's
    own folder names, dependencies, and config files and reports which of 23
    common architecture patterns (Layered, MVC, MVVM, Clean, Hexagonal, Onion,
    Repository, CQRS, Event-Driven, Microservices, Monolith, Modular Monolith,
    DDD, Serverless, Plugin, Pipeline, Pub/Sub, Actor Model, Component-Based,
    Feature-Based, Vertical Slice, BFF, API Gateway) the project matches. Each
    detected pattern gets a description + a verified external reference link
    (Wikipedia or the pattern's official/originating source).

Testing

316/316 tests passing. Added 17 new tests (4 for the tree/badge redesign, 13 for
pattern detection + rendering). Verified against this repo's own real source via
a full docs-dashboard regeneration.

Notes

  • A mid-implementation performance issue was found and fixed: pattern detection
    originally added its own deep filesystem walk, which would have slowed every
    gen-docs invocation. Fixed by reusing the walk getAllFacts() already does
    instead of adding a new one — see docs/backlog/lessions.md (2026-07-15 entry).
  • Full design rationale in docs/backlog/adr-phase-o-figma-make-exact-match.md,
    adr-architecture-tree-badges.md, and adr-architecture-pattern-detection.md.

Checklist

  • [x ] npm test passes locally
  • [ x] Added/updated tests for the behavior change (if any)
  • No new runtime dependency added (or, if one is genuinely needed, this was discussed
    in an issue first — see CONTRIBUTING.md)
  • Output remains deterministic (same input → same output, no timestamps/randomness)
  • Updated CHANGELOG.md if this is a user-facing change

@github-advanced-security github-advanced-security AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code-multivitals found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

@imchintoo imchintoo closed this Jul 16, 2026
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