You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/compodoc.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
-
# 📚 Angular Documentation with Compodoc
1
+
# Angular Documentation with Compodoc
2
2
3
3
This project uses [Compodoc](https://compodoc.app/) to generate and enforce documentation for all Angular code. Documentation is mandatory and must meet a **100% coverage threshold** to ensure consistent API clarity across the codebase.
4
4
5
5
---
6
6
7
-
## 🧪 How to Generate Documentation
7
+
## How to Generate Documentation
8
8
9
9
To generate and view the documentation locally:
10
10
@@ -19,15 +19,15 @@ This will:
19
19
20
20
---
21
21
22
-
## 📏 Documentation Coverage Requirements
22
+
## Documentation Coverage Requirements
23
23
24
24
-**100% Compodoc coverage is required** across all services, components, models, and utilities.
25
25
- All public methods, properties, and classes must be documented using proper JSDoc style comments.
26
26
- Coverage checks are enforced **before every commit** and **during CI/CD** via GitHub Actions.
27
27
28
28
---
29
29
30
-
## ✅ Pre-commit Enforcement via Husky
30
+
## Pre-commit Enforcement via Husky
31
31
32
32
Husky is configured to run a **pre-commit hook** that will:
33
33
@@ -39,15 +39,15 @@ If the hook fails, you’ll see output indicating which files or symbols are und
39
39
40
40
---
41
41
42
-
## 🔒 CI/CD Enforcement
42
+
## CI/CD Enforcement
43
43
44
44
During pull requests and merges, GitHub Actions re-validates documentation coverage.
45
45
46
46
Any PR that does not meet the 100% documentation requirement will be blocked from merging until resolved.
47
47
48
48
---
49
49
50
-
## 💡 Tips for Passing Coverage
50
+
## Tips for Passing Coverage
51
51
52
52
- Use `@Input`, `@Output`, and `@Injectable` annotations with proper descriptions.
53
53
- Document every exported interface, function, method, and variable.
@@ -56,7 +56,7 @@ Any PR that does not meet the 100% documentation requirement will be blocked fro
56
56
57
57
---
58
58
59
-
## 📁 Output Directory
59
+
## Output Directory
60
60
61
61
By default, generated documentation lives in:
62
62
@@ -68,7 +68,7 @@ This folder is **not committed to the repo** and is only used locally or in buil
0 commit comments