Skip to main content

Documentation Changelog

Track documentation updates here. Update this file whenever you modify the docs.

Format​

## [Date] - [Version/Summary]
### [Document]
- Change description

[December 2024] - Documentation Update v2​

README.md​

  • Updated to Next.js 15 version reference
  • Added CAD Integration and WebSocket Monitor to features list
  • Added comprehensive Getting Started guide with prerequisites
  • Added ML API running instructions
  • Added complete environment variables table with descriptions
  • Added project structure overview
  • Added links to Accuracy & Efficiency reports

CONFIGURATION.md​

  • Complete rewrite of environment variables section
  • Added detailed tables for each variable category
  • Added ML API, App URL, Email (Resend), Firebase, and Blockchain sections
  • Added security warnings and setup instructions
  • Added complete environment file structure template

COMPONENTS.md​

  • Added Animation Components section (9 components)
  • Added Home Components section (landing page components)
  • Added Water Recovery Components section
  • Added Animation Pattern to best practices

PROJECT_STRUCTURE.md​

  • Added CAD Integration and WebSocket Monitor routes
  • Added animation/ components directory
  • Added home/ components directory
  • Added water-recovery/ components directory
  • Added cad-integration/ lib directory
  • Added email/ lib directory
  • Added water-recovery.ts utility

FEATURES.md​

  • Added CAD Integration feature (Section 7)
  • Renumbered WebSocket Monitor to Section 8
  • Renumbered Report History to Section 9
  • Renumbered Blockchain Verification to Section 10
  • Renumbered Account Management to Section 11

ARCHITECTURE.md​

  • Added CAD Integration route
  • Added WebSocket Monitor route

[December 2024] - Initial Documentation​

README.md​

  • Created main documentation index
  • Added technology stack overview
  • Added quick start guide

ARCHITECTURE.md​

  • Documented system architecture diagram
  • Explained application layers
  • Documented data flow patterns
  • Listed design patterns used

PROJECT_STRUCTURE.md​

  • Complete folder structure documentation
  • Route groups explanation
  • Component organization
  • Naming conventions

FEATURES.md​

  • Authentication documentation
  • Dashboard features
  • Prediction Model documentation
  • Treatment Model documentation
  • Twin Engine documentation
  • Adaptive Optimizers documentation
  • Report History documentation
  • Blockchain Verification documentation
  • Account Management documentation

COMPONENTS.md​

  • UI components reference (shadcn/ui)
  • Form components documentation
  • Feedback components
  • Layout components
  • Sidebar components
  • Blockchain components
  • Chart components
  • Auth components

HOOKS.md​

  • useAuth hook documentation
  • useBlockchain hook documentation
  • useToast hook documentation
  • useMobile hook documentation
  • ML API hooks documentation
  • Report hooks documentation

SERVICES.md​

  • Firebase service documentation
  • ML API client documentation
  • Blockchain service documentation
  • Reports service documentation
  • PDF generators documentation

CONFIGURATION.md​

  • Environment variables guide
  • Application constants
  • Water quality parameters
  • Blockchain configuration
  • Next.js configuration

How to Update​

When making changes to the codebase:

  1. New Feature: Update FEATURES.md with feature description
  2. New Component: Update COMPONENTS.md with usage examples
  3. New Hook: Update HOOKS.md with API documentation
  4. New Service: Update SERVICES.md with methods/endpoints
  5. Structure Change: Update PROJECT_STRUCTURE.md
  6. Config Change: Update CONFIGURATION.md

Always add an entry to this changelog with:

  • Date
  • Document(s) modified
  • Brief description of changes

Quick Update Prompt​

Use this prompt to update documentation after changes:

Update the documentation in @docs folder:
- I added/modified [feature/component/hook/service]
- Location: [file path]
- Changes: [description]
Please update the relevant docs and add to CHANGELOG.md