Skip to content

Latest commit

 

History

History
89 lines (73 loc) · 10.4 KB

README.md

File metadata and controls

89 lines (73 loc) · 10.4 KB

Documentation Index

This directory contains the main contributor and operations documentation for the ILN Frontend project. Use this page as the starting point when you need context on architecture, testing, CI, accessibility, or implementation details.

Core Guides

  • architecture.md - Frontend architecture overview covering design decisions, folder structure, and major data-flow patterns.
  • data-fetching-architecture.md - Consolidated TanStack Query data-fetching architecture, key factories, caching defaults, and mutation patterns.
  • developer-quickstart.md - End-to-end setup guide from a fresh clone through local development and initial verification.
  • testing.md - Testing strategy and conventions for Vitest, Playwright, and other quality checks.
  • ci-cd.md - GitHub Actions, deployment flow, and CI/CD runner guidance.

Quality and Performance

Product and Domain Documentation

Mainnet Launch Readiness: Dark-Feature Re-enablement

These runbooks define the step-by-step sequence for safely re-enabling each feature that ships dark at mainnet launch. Each runbook covers the readiness gate, flag flip, smoke test, visual regression check, and rollback plan, and cross-links the corresponding backend readiness work. All three features require both frontend and backend gates to be complete before the flag is flipped.

Operations, Security, and Incident Readiness

Hooks and Examples

  • hooks/ - Detailed documentation for custom React hooks, including the authenticated-wallet hook reference.
  • examples/ - Example assets and snippets used across the documentation set.

Keep this index updated whenever new documentation is added to the docs directory so contributors can find it quickly.