Commit 1692091
committed
docs: Update README with comprehensive documentation index
Enhanced README Documentation section to include all new materials:
Added to Getting Started:
- Quick Reference (one-page cheat sheet)
- Troubleshooting guide
Added to Advanced Topics:
- Comparison Guide (vs Pylint, MyPy, Pytest, etc.)
New Sections:
- Examples & Integration section with:
- Real-World Bugs (7 examples)
- Refactoring Journey (5 examples)
- Severity Levels (complete spectrum)
- Integration Templates (GitHub Actions, pre-commit, VS Code, config)
- Project Documentation section with:
- Changelog (version history and roadmap)
This provides complete navigation to all ~31,700 words of documentation
and makes it easy for users to find the resources they need.1 parent 091121e commit 1692091
1 file changed
+51
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
97 | 103 | | |
98 | 104 | | |
99 | 105 | | |
| |||
111 | 117 | | |
112 | 118 | | |
113 | 119 | | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
114 | 126 | | |
115 | 127 | | |
116 | 128 | | |
| |||
129 | 141 | | |
130 | 142 | | |
131 | 143 | | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
132 | 183 | | |
133 | 184 | | |
134 | 185 | | |
| |||
0 commit comments