Review and streamline project documentation

[mrspatbile]

Objective

Review the project documentation to ensure it reflects the current implementation, uses consistent regulatory terminology, and avoids unnecessary duplication.

Scope

• Review all project documentation for consistency and completeness.
• Clarify the purpose of each document and remove overlapping content where appropriate.
• Ensure terminology is consistent across the repository.
• Prefer regulatory terminology where applicable over internal or technical wording.
• Align documentation with the current dashboard, methodology, and liquidation engine.
• Remove obsolete descriptions left from earlier implementations.
• Verify that architecture, methodology, and implementation details are documented in the appropriate documents.

Regulatory terminology review

Review terminology against ESMA, CSSF, UCITS, and AIFMD guidance where relevant.

Examples include:

• Threshold breach (avoid "trigger" or "activation threshold" where inappropriate)
• LMT application / application timing
• Liquidity Management Tool
• Normal market conditions
• Stressed market conditions
• Redemption pressure
• Notice period
• Settlement period
• Liquidity shortfall
• Deferred redemptions
• Backlog
• Liquidation strategy
• Liquidity capacity

Replace overly technical or implementation-oriented wording where a recognised regulatory term is more appropriate.

Acceptance criteria

• Documentation reflects the current implementation.
• Each document has a clearly defined purpose with minimal duplication.
• Regulatory terminology is used consistently throughout the repository.
• Outdated terminology and obsolete descriptions are removed.
• Dashboard, methodology, and architecture documentation are aligned.
• Internal implementation details remain in technical documentation and are not duplicated in user-facing documentation.
• All documentation is reviewed for consistency before the v0.6.0 release.

Out of scope

• Methodology changes.
• Engine implementation changes.
• UI changes.
• New documentation sections unrelated to the current functionality.