Commit 962e667
committed
fix: improve documentation page and API robustness
Fixes identified in PR code review:
**docs/js/main.js:**
- Improve platform asset classification using regex word boundaries instead of
indexOf() to avoid substring conflicts (e.g., 'darwin-linux' misclassification)
- Add cache expiration mechanism (1 hour) for GitHub API responses to show
latest release information
- Enhance URL validation to restrict to HTTPS and authorized GitHub domains
(github.com, github.io, githubusercontent.com)
**docs/documentation.html:**
- Fix footer documentation links to point to correct GitHub file locations
instead of non-existent local markdown files
- Add ARIA labels (role='navigation', aria-label) for better accessibility
- Implement slugify() function to generate stable heading IDs from text
(e.g., 'C++ API Reference' -> 'cpp-api-reference') for durable anchor links
- Improve error messages with context-specific feedback (network vs file not found)
- Fix missing closing brace in generateSidebar() function
- Optimize sidebar navigation to make all headings clickable without duplication
**README.md:**
- Restore 'Dual Language APIs' feature description (was commented out)1 parent fcf5383 commit 962e667
3 files changed
Lines changed: 71 additions & 29 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
69 | | - | |
70 | | - | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
| |||
196 | 196 | | |
197 | 197 | | |
198 | 198 | | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
199 | 207 | | |
200 | | - | |
201 | | - | |
| 208 | + | |
| 209 | + | |
202 | 210 | | |
203 | 211 | | |
204 | 212 | | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
205 | 231 | | |
206 | 232 | | |
207 | 233 | | |
| |||
216 | 242 | | |
217 | 243 | | |
218 | 244 | | |
219 | | - | |
220 | | - | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
221 | 252 | | |
222 | | - | |
| 253 | + | |
223 | 254 | | |
224 | 255 | | |
225 | 256 | | |
| |||
229 | 260 | | |
230 | 261 | | |
231 | 262 | | |
232 | | - | |
| 263 | + | |
| 264 | + | |
233 | 265 | | |
234 | 266 | | |
235 | 267 | | |
236 | | - | |
| 268 | + | |
| 269 | + | |
237 | 270 | | |
238 | 271 | | |
239 | 272 | | |
| |||
244 | 277 | | |
245 | 278 | | |
246 | 279 | | |
247 | | - | |
248 | | - | |
249 | | - | |
250 | | - | |
251 | | - | |
252 | | - | |
253 | | - | |
254 | 280 | | |
255 | 281 | | |
256 | 282 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| 63 | + | |
| 64 | + | |
63 | 65 | | |
64 | 66 | | |
65 | | - | |
| 67 | + | |
| 68 | + | |
66 | 69 | | |
67 | 70 | | |
68 | 71 | | |
| |||
75 | 78 | | |
76 | 79 | | |
77 | 80 | | |
| 81 | + | |
78 | 82 | | |
79 | 83 | | |
80 | 84 | | |
| |||
100 | 104 | | |
101 | 105 | | |
102 | 106 | | |
103 | | - | |
| 107 | + | |
104 | 108 | | |
105 | 109 | | |
106 | 110 | | |
107 | 111 | | |
108 | | - | |
109 | | - | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
110 | 117 | | |
111 | 118 | | |
112 | 119 | | |
| |||
154 | 161 | | |
155 | 162 | | |
156 | 163 | | |
157 | | - | |
| 164 | + | |
| 165 | + | |
158 | 166 | | |
159 | | - | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
160 | 170 | | |
161 | | - | |
162 | | - | |
163 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
164 | 174 | | |
165 | | - | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
166 | 182 | | |
167 | 183 | | |
168 | 184 | | |
| |||
0 commit comments