Skip to content

Commit 7940b7c

Browse files
committed
chore(icons): Removed the icons
1 parent f755539 commit 7940b7c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/compodoc.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# 📚 Angular Documentation with Compodoc
1+
# Angular Documentation with Compodoc
22

33
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.
44

55
---
66

7-
## 🧪 How to Generate Documentation
7+
## How to Generate Documentation
88

99
To generate and view the documentation locally:
1010

@@ -19,15 +19,15 @@ This will:
1919

2020
---
2121

22-
## 📏 Documentation Coverage Requirements
22+
## Documentation Coverage Requirements
2323

2424
- **100% Compodoc coverage is required** across all services, components, models, and utilities.
2525
- All public methods, properties, and classes must be documented using proper JSDoc style comments.
2626
- Coverage checks are enforced **before every commit** and **during CI/CD** via GitHub Actions.
2727

2828
---
2929

30-
## Pre-commit Enforcement via Husky
30+
## Pre-commit Enforcement via Husky
3131

3232
Husky is configured to run a **pre-commit hook** that will:
3333

@@ -39,15 +39,15 @@ If the hook fails, you’ll see output indicating which files or symbols are und
3939

4040
---
4141

42-
## 🔒 CI/CD Enforcement
42+
## CI/CD Enforcement
4343

4444
During pull requests and merges, GitHub Actions re-validates documentation coverage.
4545

4646
Any PR that does not meet the 100% documentation requirement will be blocked from merging until resolved.
4747

4848
---
4949

50-
## 💡 Tips for Passing Coverage
50+
## Tips for Passing Coverage
5151

5252
- Use `@Input`, `@Output`, and `@Injectable` annotations with proper descriptions.
5353
- 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
5656

5757
---
5858

59-
## 📁 Output Directory
59+
## Output Directory
6060

6161
By default, generated documentation lives in:
6262

@@ -68,7 +68,7 @@ This folder is **not committed to the repo** and is only used locally or in buil
6868

6969
---
7070

71-
## 🛠 Need Help?
71+
## Need Help?
7272

7373
Run the following to see detailed CLI options:
7474

0 commit comments

Comments
 (0)