Skip to content

Commit 21f254b

Browse files
committed
BN-19 | Add. Hyperlinks Cross Markdowns
1 parent 93551ad commit 21f254b

File tree

3 files changed

+3
-84
lines changed

3 files changed

+3
-84
lines changed

Project-setup.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ For a comprehensive setup guide including development environments, Docker confi
3434

3535
### Additional Documentation
3636

37+
- [Frontend Architecture](docs/architecture.md) - A comprehensive overview of the Bahmni Clinical Frontend architecture
38+
- [Project Structure](docs/project-structure.md) - A high-level overview of the project structure
3739
- [i18n Guide](docs/i18n-guide.md) - Internationalization implementation details
3840
- [Expandable Data Table Guide](docs/expandable-data-table-guide.md) - Usage of the expandable data table component
3941
- [Global Notification Guide](docs/global-notification-guide.md) - Using the notification system

docs/architecture.md

Lines changed: 1 addition & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -38,84 +38,7 @@ The Bahmni Clinical Frontend is a React TypeScript application built to provide
3838

3939
## Directory Structure
4040

41-
### `/docs`
42-
43-
Contains project documentation, including setup guides and component usage documentation.
44-
45-
### `/public`
46-
47-
Contains static assets that are copied to the build directory during the build process.
48-
49-
- `locales/`: Translation files for different languages
50-
- `index.html`: HTML template for the application
51-
52-
### `/src`
53-
54-
Contains the application source code.
55-
56-
#### `/components`
57-
58-
Reusable UI components that are not specific to any particular feature or domain.
59-
60-
- `/common`: Shared components used throughout the application
61-
62-
#### `/constants`
63-
64-
Application-wide constants, including error messages, date formats, and other configuration values.
65-
66-
#### `/contexts`
67-
68-
React contexts for global state management.
69-
70-
#### `/displayControls`
71-
72-
Components for displaying clinical data in a structured format.
73-
74-
#### `/hooks`
75-
76-
Custom React hooks that encapsulate business logic and data fetching.
77-
78-
#### `/layouts`
79-
80-
Components that define the overall layout of the application.
81-
82-
#### `/pages`
83-
84-
Top-level page components that are rendered by the router.
85-
86-
#### `/providers`
87-
88-
Context providers that wrap the application to provide global state.
89-
90-
#### `/schemas`
91-
92-
JSON schemas for validating data structures.
93-
94-
- `clinicalConfig.schema.json`: Schema for clinical configuration
95-
96-
#### `/services`
97-
98-
Modules that handle API communication and other external services.
99-
100-
#### `/styles`
101-
102-
Global styles for the application.
103-
104-
#### `/types`
105-
106-
TypeScript type definitions for the application.
107-
108-
#### `/utils`
109-
110-
Utility functions used throughout the application.
111-
112-
#### `/\_\_mocks\_\_`
113-
114-
Mock data and functions for testing.
115-
116-
#### `/\_\_tests\_\_`
117-
118-
Test files for components and utilities.
41+
You can find the project structure [here](./project-structure.md)
11942

12043
## Core Concepts
12144

0 commit comments

Comments
 (0)