Skip to content

refactor: use automd for README updates#14

Merged
onmax merged 4 commits intomainfrom
refactor/use-automd
Oct 31, 2025
Merged

refactor: use automd for README updates#14
onmax merged 4 commits intomainfrom
refactor/use-automd

Conversation

@onmax
Copy link
Owner

@onmax onmax commented Oct 31, 2025

Summary

Replace manual README update logic with automd for file includes

Changes

  • Add automd as dev dependency
  • Use automd for <\!-- automd:file --> markers (apps, resources, exchanges, explorers, RPC)
  • Keep custom TOC generator (automd does not have native TOC yet - PR#72 open)
  • Reduce README update code from ~130 lines to ~30 lines
  • Simplify comments (focus on why, not what)
  • Add Nimiq Hub logo to README header

Benefits

  • Cleaner, maintainable code
  • Leverages automd file inclusion system
  • Same script pattern: validation → API fetch → markdown gen → README update
  • GitHub workflow unchanged

Test plan

  • Build passes
  • Lint passes
  • README correctly updated with all sections
  • TOC generated properly

@onmax onmax force-pushed the refactor/use-automd branch from df0a3e8 to 4fb964b Compare October 31, 2025 06:12
@onmax onmax merged commit ce1b4ee into main Oct 31, 2025
@onmax onmax deleted the refactor/use-automd branch October 31, 2025 06:28
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