Skip to content

Commit 081eb13

Browse files
Add Table of Contents for better README navigation (#3450)
Add comprehensive Table of Contents for better README navigation **Changes:** - Added `## 📋 Table of Contents` after Overview section - 30+ anchor links covering Installation, Docker, Proxy, Environment Vars, RBAC - Improves scannability for 2000+ line document **Impact:** - New contributors find sections instantly - Reduces support questions about "how to install" - Standard open source README best practice
1 parent 1f7df81 commit 081eb13

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,43 @@ Mifos® X Web App is a modern single-page application (SPA) built on top of the
1010
- Angular framework
1111
- Angular Material components
1212

13+
## 📋 Table of Contents
14+
15+
- [Overview](#overview)
16+
- [Quick Links](#quick-links)
17+
- [Installation Guide](#installation-guide)
18+
- [Prerequisites](#prerequisites-for-all-methods)
19+
- [Backend Setup](#backend-setup-required-first)
20+
- [Frontend Setup](#frontend-setup-web-app)
21+
- [Method 1: Manual Installation](#method-1-manual-installation)
22+
- [Method 2: Docker](#method-2-docker-container-only)
23+
- [Method 3: Docker Compose](#method-3-docker-compose-frontend--backend)
24+
- [Default Login Credentials](#default-login-credentials)
25+
- [Development Commands](#development-commands)
26+
- [Proxy Configuration](#proxy-configuration)
27+
- [Sandbox Proxy](#using-the-sandbox-proxy-default)
28+
- [Local Fineract](#using-a-local-fineract-instance)
29+
- [Testing the Proxy](#testing-the-proxy)
30+
- [Configuration Options](#configuration-options)
31+
- [Environment Variables for Docker](#environment-variables-for-docker)
32+
- [Fineract Backend](#fineract-backend-settings)
33+
- [Language Settings](#language-settings-i18n)
34+
- [Date Formats](#date-and-datetime-format-settings)
35+
- [Session & Performance](#session--performance-settings)
36+
- [Password Policy](#password-policy-settings)
37+
- [UI Display](#ui-display-settings)
38+
- [OAUTH](#oauth-settings)
39+
- [OIDC](#oidc-settings)
40+
- [External National ID](#external-national-id-system-integration)
41+
- [Interbank Transfers](#interbank-transfers-settings)
42+
- [Remittance Module](#remittance-module-settings)
43+
- [Client Data Masking](#client-data-masking-example)
44+
- [Interbank Transfer Menu](#interbank-transfer-menu)
45+
- [Role-Based Access Control](#role-based-access-control-rbac)
46+
- [Releases](#releases)
47+
- [Contributing](#contributing)
48+
- [Related Projects](#related-projects)
49+
1350
## Quick Links
1451

1552
- [Live Demo](https://demo.mifos.community/#/login) (Updated nightly — sandbox data is reset every 6 hours; test data and transient state may be cleared.)

0 commit comments

Comments
 (0)