@@ -4,14 +4,14 @@ Current status of mPower Device API schema documentation.
44
55## Progress Summary
66
7- ** Last Updated** : December 17, 2025
7+ ** Last Updated** : February 11, 2026
88
99### Completion Status
1010
1111| Category | Schemas | Documented | Percentage |
1212| ----------| ---------| ------------| ------------|
13- | ** High Priority** | 3 | 3 | 100% ✅ |
14- | ** Medium Priority** | 14 | 7 | 50 % |
13+ | ** High Priority** | 3 | 3 | 100% |
14+ | ** Medium Priority** | 17 | 7 | 41 % |
1515| ** Low Priority** | 33 | 0 | 0% |
1616| ** Partial (OpenAPI)** | 7 | 7 | 100% |
1717| ** TOTAL** | 57 | 17 | 30% |
@@ -158,49 +158,73 @@ These schemas have < 10 properties and can be documented more quickly or expande
158158| Low Priority (33 schemas) | 40-60 hours |
159159| ** TOTAL REMAINING** | ** 110-164 hours** |
160160
161- ## Recommended Next Steps
161+ ## Site Infrastructure (February 2026)
162162
163- ### Phase 1: Complete High Priority (Week 1)
163+ ### Completed
164164
165- 1 . ✅ ** loraNetwork** - DONE
166- 2 . ✅ ** ni** (Network Interfaces) - DONE
167- 3 . ⏳ ** snmp** (SNMP Agent) - TODO
168- 4 . ⏳ ** alert** (Alerting System) - TODO
165+ - ** Site redesign** — Modern layout with fixed header, sidebar navigation, breadcrumbs, page TOC
166+ - ** Search functionality** — Client-side full-text search across all pages (SimpleJekyllSearch)
167+ - ** Version selector** — v1.0 / v2.0 dropdown in sidebar
168+ - ** Mobile responsive** — Hamburger nav, collapsible sidebar, responsive search
169+ - ** Navigation structure** — ` _data/navigation.yml ` with expandable sections
170+ - ** OpenAPI/Swagger** — Modular YAML files in ` mpower-api-docs/openapi/ `
171+ - ** Development guides** — Conduit custom app, Cursor AI dev, Dot development
169172
170- ** Estimated completion ** : 1 week (20-30 hours )
173+ ### Search fix (February 11, 2026 )
171174
172- ### Phase 2: Security & VPN (Weeks 2-3)
175+ - Pinned CDN to ` simple-jekyll-search@1.10.0 ` (was ` @latest ` on unpkg)
176+ - Removed unused jQuery dependency
177+ - Replaced ` input ` event visibility toggle with ` MutationObserver `
178+ - Added diagnostic console logging for search index load
173179
174- Create consolidated documentation files:
180+ ### Pages missing YAML frontmatter
175181
176- 1 . ** VPN-SCHEMAS.md** - Document ipsecTunnels, greTunnels, ovpnTunnels
177- - Combined effort: 17-23 hours
182+ These pages render but lack ` title ` and ` category ` metadata, which affects search results and SEO:
178183
179- 2 . ** NAT-FIREWALL-SCHEMAS.md** - Document nat, firewall, filters, routes
180- - Combined effort: 19-26 hours
184+ | Page | Status |
185+ | ------| --------|
186+ | ` basic-station.md ` | Empty file (0 lines) — stub |
187+ | ` dot-development-xdot.md ` | Content exists, needs frontmatter |
188+ | ` dot-migrate-to-4.md ` | Content exists, needs frontmatter |
189+ | ` lorawan-app-connect-mqtt-azure.md ` | Content exists, needs frontmatter |
190+ | ` lorawan-app-connect-mqtt-websockets.md ` | Content exists, needs frontmatter |
191+ | ` lorawan-app-connect-walkthrough.md ` | Content exists, needs frontmatter |
192+ | ` xdot-daplink.md ` | Content exists, needs frontmatter |
181193
182- 3 . ** SECURITY-SCHEMAS.md** - Document secureProtocols, remoteAccess, trustedIp, radius
183- - Combined effort: 18-25 hours
194+ ## Recommended Next Steps
184195
185- ** Estimated completion ** : 2-3 weeks (54-74 hours )
196+ ### Phase 1: Site Quality (Quick wins )
186197
187- ### Phase 3: Services & Integration (Week 4)
198+ 1 . Add YAML frontmatter to the 6 pages listed above
199+ 2 . Write ` basic-station.md ` content (currently empty)
200+ 3 . Verify search works after CDN fix deploys
188201
189- Create consolidated documentation file:
202+ ### Phase 2: Remaining Medium Priority Schemas
190203
191- 1 . ** SERVICES-SCHEMAS.md** - Document ddns, mqttBroker, smtp, sms, scada, remoteMgmt
192- - Combined effort: 25-37 hours
204+ | Schema | Estimated Effort |
205+ | --------| ------------------|
206+ | ` secureProtocols ` | 5-7 hours |
207+ | ` remoteAccess ` | 5-7 hours |
208+ | ` radius ` | 4-6 hours |
209+ | ` trustedIp ` | 3-4 hours |
210+ | ` ddns ` | 5-7 hours |
211+ | ` mqttBroker ` | 4-6 hours |
212+ | ` scada ` | 4-6 hours |
213+ | ` remoteMgmt ` | 4-6 hours |
214+ | ` sms ` | 3-5 hours |
215+ | ` smtp ` | 3-5 hours |
193216
194- ** Estimated completion** : 1 week (25-37 hours)
217+ ** Medium Priority Completed** : 7/17 (41%)
218+ ** Remaining Medium Priority Effort** : 40-59 hours
195219
196- ### Phase 4 : Complete Coverage (Weeks 5-6)
220+ ### Phase 3 : Complete Coverage
197221
198- 1 . Expand OpenAPI specification with inline documentation for all low-priority schemas
222+ 1 . Expand OpenAPI spec with inline documentation for all low-priority schemas
1992232 . Add configuration examples
2002243 . Create troubleshooting guides
2012254 . Add cross-references between related schemas
202226
203- ** Estimated completion** : 2 weeks ( 40-60 hours)
227+ ** Estimated completion** : 40-60 hours
204228
205229## Documentation Quality Standards
206230
@@ -225,11 +249,14 @@ Each schema documentation should include:
225249
226250## Benefits Tracking
227251
228- ### Current Benefits (16 % completion)
252+ ### Current Benefits (30 % completion)
229253
230254- ** loraNetwork** : Complete LoRa configuration reference
231255- ** ni** : Complete network interface configuration reference
232- - Reduced support questions for these two critical resources
256+ - ** VPN/NAT/Firewall** : Complete security and networking reference
257+ - ** SNMP/Alerting** : Complete monitoring configuration reference
258+ - ** Site redesign** : Modern, searchable, mobile-friendly documentation
259+ - Reduced support questions for critical resources
233260- Faster integration for developers
234261
235262### Expected Benefits (100% completion)
@@ -243,23 +270,32 @@ Each schema documentation should include:
243270
244271## Metrics
245272
246- ### Documentation Coverage
273+ ### API Schema Documentation Coverage
274+
275+ ```
276+ Progress: [██████████░░░░░░░░░░░░░░░░░░░░░░] 30% (17/57 schemas)
277+ ```
278+
279+ ### Site Page Coverage
247280
248281```
249- Progress: [████████░░░░░░░░░░░░░░░░░░░░░░░░] 16% (9/57 schemas)
282+ Pages with frontmatter: 11/18 (61%)
283+ Pages with content: 17/18 (94%) — basic-station.md is empty
250284```
251285
252286### Effort Invested
253287
254- - ** Completed** : ~ 30 hours
255- - ** Remaining** : ~ 110-164 hours
256- - ** Total Project** : ~ 140-194 hours
288+ - ** Completed** : ~ 50 hours (schemas) + ~ 20 hours (site redesign)
289+ - ** Remaining** : ~ 80-125 hours (schemas)
290+ - ** Total Project** : ~ 150-195 hours
257291
258292### Timeline
259293
260294- ** Started** : December 17, 2025
261- - ** Current Phase** : Phase 1 (High Priority)
262- - ** Estimated Completion** : March 2026 (at 20 hours/week)
295+ - ** Site Redesign** : February 10, 2026
296+ - ** Search Fix** : February 11, 2026
297+ - ** Current Phase** : Site quality + Phase 2 (Medium Priority schemas)
298+ - ** Estimated Completion** : April 2026 (at 10-15 hours/week)
263299
264300## How to Contribute
265301
@@ -285,6 +321,6 @@ See [LORA-NETWORK-SCHEMA.md](LORA-NETWORK-SCHEMA.md) or [NETWORK-INTERFACES-SCHE
285321
286322---
287323
288- ** Document Version** : 1 .0
289- ** Last Updated** : December 17, 2025
290- ** Next Review** : Weekly until Phase 1 complete
324+ ** Document Version** : 2 .0
325+ ** Last Updated** : February 11, 2026
326+ ** Next Review** : Weekly
0 commit comments