File tree Expand file tree Collapse file tree 5 files changed +541
-184
lines changed
Expand file tree Collapse file tree 5 files changed +541
-184
lines changed Original file line number Diff line number Diff line change @@ -16,3 +16,4 @@ components.d.ts
1616# vale
1717.github /styles /*
1818! .github /styles /config /vocabularies /
19+ vale-report.txt
Original file line number Diff line number Diff line change @@ -110,19 +110,23 @@ export function getSidebar() {
110110 link : '/get-started/protocol/proof-of-contribution' ,
111111 } ,
112112 {
113- text : '💸 Pay Per Task Model' ,
113+ text : 'Pay Per Task Model' ,
114114 link : '/get-started/protocol/pay-per-task' ,
115115 } ,
116116 {
117- text : '⚙️ Workers & Workerpools' ,
117+ text : 'Oracle' ,
118+ link : '/get-started/protocol/oracle' ,
119+ } ,
120+ {
121+ text : 'Workers & Workerpools' ,
118122 collapsed : true ,
119123 items : [
120124 {
121- text : '🚀 Worker Quick Start' ,
125+ text : 'Worker Quick Start' ,
122126 link : '/get-started/protocol/worker/quick-start' ,
123127 } ,
124128 {
125- text : '🔒 Manage Workerpool Access' ,
129+ text : 'Manage Workerpool Access' ,
126130 link : '/get-started/protocol/worker/manage-access' ,
127131 } ,
128132 ] ,
Original file line number Diff line number Diff line change @@ -49,6 +49,9 @@ vale src/get-started/helloWorld/1-overview.md
4949
5050# Get detailed output
5151vale --output=line src/
52+
53+ # Generate comprehensive report with statistics
54+ vale --output=line src/ > vale-report.txt 2>&1
5255```
5356
5457#### Vale Rules
@@ -61,6 +64,29 @@ ensure:
6164- Professional tone
6265- Accessibility best practices
6366
67+ #### Vale Statistics and Reports
68+
69+ Generate comprehensive reports to track documentation quality:
70+
71+ ** Current Statistics (as of latest run):**
72+
73+ - ** Total Issues** : 2,731
74+ - ** Top Issues** :
75+ - Headings capitalization (622)
76+ - Acronyms explanation (472)
77+ - Passive voice (460)
78+ - Word choice (294)
79+ - Parentheses usage (244)
80+
81+ ** Files with Most Issues:**
82+
83+ 1 . ` proof-of-contribution.md ` (323 issues)
84+ 2 . ` glossary.md ` (143 issues)
85+ 3 . ` quick-start-for-developers.md ` (75 issues)
86+
87+ ** Quality Score** : Based on the number of issues per file, we can calculate a
88+ quality percentage and track improvements over time.
89+
6490### Environment Variables (Optional)
6591
6692Some features of the application require environment variables. This
You can’t perform that action at this time.
0 commit comments