Skip to content

docs(readme): update architecture diagram to reflect current file structure - #162

Merged
andrerfneves merged 1 commit into
mainfrom
maintenance/fix-readme-architecture-20260609
Jun 9, 2026
Merged

andrerfneves merged 1 commit into
mainfrom
maintenance/fix-readme-architecture-20260609

Conversation

@andrerfneves

Copy link
Copy Markdown
Owner

Summary

Updates the Architecture section component tree diagram in README.md to include files and directories that were missing from the previous listing.

Problem

The architecture diagram was last updated in PR #143, but several key files added since then were omitted:

  • src/constants/ directory with shared key constants was not listed
  • src/main.tsx entry point was missing
  • src/index.css global styles/Tailwind config was missing
  • payment-hash-verifier.tsx and qr-scanner.tsx components were missing
  • Generic patterns for Storybook stories and test files were not mentioned

Changes

  • Added src/constants/keys.js under a new constants/ directory
  • Added src/main.tsx and src/index.css at the top level
  • Added payment-hash-verifier.tsx and qr-scanner.tsx to components
  • Added *.stories.tsx and *.test.tsx patterns to components
  • Added *.test.js patterns to utils
  • Aligned spacing for consistent column formatting

Verification

  • Tree diagram renders correctly in markdown
  • No application code changes

…ucture

The architecture diagram was missing several directories and files that
were added since the last update:
- src/constants/ directory with shared key constants
- src/main.tsx entry point
- src/index.css global styles
- payment-hash-verifier.tsx and qr-scanner.tsx components
- Generic *.stories.tsx and *.test.tsx patterns
- Utility test files
@vercel

vercel Bot commented Jun 9, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
lightning-decoder Ready Ready Preview, Comment Jun 9, 2026 8:04am

@andrerfneves
andrerfneves merged commit ee2aebc into main Jun 9, 2026
4 checks passed
@andrerfneves
andrerfneves deleted the maintenance/fix-readme-architecture-20260609 branch June 9, 2026 13:48

This branch was successfully deployed

1 active deployment
Preview — b5ab1354 Deployed Jun 9, 2026 by vercel[bot]
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