hiveiq-src/hiveops-guide
4
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases Wiki Activity

Rebuild guide as markdown-driven, tabbed, API-served (retire DB/CRUD) #1

New Issue
Open
opened 2026-06-30 23:38:30 -04:00 by hiveiq · 0 comments
hiveiq commented 2026-06-30 23:38:30 -04:00
Owner
Copy Link
Copy Source

Per DESIGN.md (committed to develop). Greenfield rebuild:

  1. Backend (this phase) — read markdown from content/**/*.md (frontmatter: module/title/tab/order/audience), serve GET /api/v1/guide/nav + GET /api/v1/guide/modules/{module}; retire the DB content_json model + admin CRUD; audience gates customer vs internal (role-based).
  2. Frontend tabbed slide-out reader.
  3. Author content (devices.sw-deploy + fleet.tasks pattern), then all modules.
  4. Technical guides (internal).

Decisions: markdown files in git served via API; start over (no compat shim); retire Guide Admin CRUD, keep internal docs.

Per DESIGN.md (committed to develop). Greenfield rebuild: 1. **Backend** (this phase) — read markdown from `content/**/*.md` (frontmatter: module/title/tab/order/audience), serve `GET /api/v1/guide/nav` + `GET /api/v1/guide/modules/{module}`; retire the DB content_json model + admin CRUD; `audience` gates customer vs internal (role-based). 2. Frontend tabbed slide-out reader. 3. Author content (devices.sw-deploy + fleet.tasks pattern), then all modules. 4. Technical guides (internal). Decisions: markdown files in git served via API; start over (no compat shim); retire Guide Admin CRUD, keep internal docs.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Bug
Backend
Service, API, or data-layer work
 Breaking
Breaking change that won't be backward compatible
 Bug
Something is not working
 Dev Verified
Fix verified on bcos.dev by QA — cleared for production release
 Documentation
Documentation changes
 Enhancement
Improve existing functionality
 Feature
New functionality
 Frontend
UI / Svelte SPA work
 Pattern
For changes to our agent Pattern for detecting hardware faults
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reopen
Fix was verified but the issue persists or regressed. Reopen and reassign for investigation.
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Security
This is security issue
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
TEST
Tested
Not Fixed
Testing
Issue or pull request related to testing
 Verify Fix
Fix has been deployed to production. Verify the issue is resolved before closing.
 Verify/Production
Fix deployed to production — verify before closing
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
hiveiq hiveiq-browser johannes tristan (Tristan Smith)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: hiveiq-src/hiveops-guide#1
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?