swanadiva/HostKeeper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: flatten docs/ — move V2 docs from docs/v2/ to docs/

Browse Source 
- git mv docs/v2/*.md docs/ (11 planning documents)
- Remove empty docs/v2/ directory
- Update all references: AGENTS.md, CHANGELOG.md, README.md, ARCHITECTURE.md
- Fix outdated repo tree in ARCHITECTURE.md to match actual structure
This commit is contained in:
swanadiva
2026-07-07 12:04:59 +07:00
parent 7794ca554b
commit c215d68c81
13 changed files with 63 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+8 -9
View File
@@ -24,8 +24,7 @@ hostkeeper/ (root — bersih untuk V2)
├── mobile/ ← (BELUM DIBUAT) V2 mobile wrapper ├── mobile/ ← (BELUM DIBUAT) V2 mobile wrapper
├── template/ ← Referensi UI React (Lumina System) ├── template/ ← Referensi UI React (Lumina System)
│ └── src/components/ 7 React screens (Dashboard, Terminal, SFTP, Snippets, Keychain, Settings, Brief) │ └── src/components/ 7 React screens (Dashboard, Terminal, SFTP, Snippets, Keychain, Settings, Brief)
├── docs/ ├── docs/ ← Dokumentasi perencanaan V2 (10 file, 6,310 baris)
│ └── v2/ ← Dokumentasi perencanaan V2 (10 file, 6,310 baris)
└── AGENTS.md ← file ini (checkpoint AI) └── AGENTS.md ← file ini (checkpoint AI)
Git branches: Git branches:
@@ -50,7 +49,7 @@ Git branches:
## 3. V2 Status — Pre-Development ## 3. V2 Status — Pre-Development
### ✅ Sudah Selesai ### ✅ Sudah Selesai
- 10 dokumen perencanaan di `docs/v2/`: - 10 dokumen perencanaan di `docs/`:
- `ARCHITECTURE.md` — GoFiber v2 + React + Electron + mobile WebView - `ARCHITECTURE.md` — GoFiber v2 + React + Electron + mobile WebView
- `API.md` — REST + WebSocket spec (1,303 baris) - `API.md` — REST + WebSocket spec (1,303 baris)
- `DATA_MODELS.md` — Host, Group, Snippet, Key, PortForward, Workspace, Config - `DATA_MODELS.md` — Host, Group, Snippet, Key, PortForward, Workspace, Config
@@ -138,12 +137,12 @@ Step 9: Setup Electron: npm install electron electron-builder --save-dev
| Untuk | Lihat di | | Untuk | Lihat di |
|-------|----------| |-------|----------|
| Arsitektur lengkap | `docs/v2/ARCHITECTURE.md` | | Arsitektur lengkap | `docs/ARCHITECTURE.md` |
| API spec | `docs/v2/API.md` | | API spec | `docs/API.md` |
| Data models | `docs/v2/DATA_MODELS.md` | | Data models | `docs/DATA_MODELS.md` |
| UI component tree | `docs/v2/UI_COMPONENTS.md` | | UI component tree | `docs/UI_COMPONENTS.md` |
| Sprint plan detail | `docs/v2/SPRINT_PLAN.md` | | Sprint plan detail | `docs/SPRINT_PLAN.md` |
| Template analysis + bugs | `docs/v2/TEMPLATE_ANALYSIS.md` | | Template analysis + bugs | `docs/TEMPLATE_ANALYSIS.md` |
| Template source code | `template/src/components/` | | Template source code | `template/src/components/` |
| Template AGENTS.md | `template/AGENTS.md` (desain system) | | Template AGENTS.md | `template/AGENTS.md` (desain system) |
| V1 shared packages | `v1/pkg/ssh/`, `v1/pkg/crypto/`, `v1/pkg/storage/`, `v1/pkg/config/`, `v1/pkg/knownhosts/` | | V1 shared packages | `v1/pkg/ssh/`, `v1/pkg/crypto/`, `v1/pkg/storage/`, `v1/pkg/config/`, `v1/pkg/knownhosts/` |
CHANGELOG.md
+9 -9
View File
@@ -3,15 +3,15 @@
## [Unreleased] — V2 Planning Complete (2026-06-29) ## [Unreleased] — V2 Planning Complete (2026-06-29)
### Added (V2 Planning Documents) ### Added (V2 Planning Documents)
- `docs/v2/PROGRESS.md` — Status tracker for V2 development - `docs/PROGRESS.md` — Status tracker for V2 development
- `docs/v2/ARCHITECTURE.md` — System architecture (GoFiber + React + Electron) - `docs/ARCHITECTURE.md` — System architecture (GoFiber + React + Electron)
- `docs/v2/API.md` — REST API + WebSocket specification - `docs/API.md` — REST API + WebSocket specification
- `docs/v2/DATA_MODELS.md` — Extended data models (Groups, PortForward, Workspace) - `docs/DATA_MODELS.md` — Extended data models (Groups, PortForward, Workspace)
- `docs/v2/UI_COMPONENTS.md` — React component tree + state management - `docs/UI_COMPONENTS.md` — React component tree + state management
- `docs/v2/UI_TERMIUS_REFERENCE.md` — Termius visual reference - `docs/UI_TERMIUS_REFERENCE.md` — Termius visual reference
- `docs/v2/SPRINT_PLAN.md` — Sprint-by-sprint task breakdown - `docs/SPRINT_PLAN.md` — Sprint-by-sprint task breakdown
- `docs/v2/BUILD_SYSTEM.md` — Cross-platform build pipeline - `docs/BUILD_SYSTEM.md` — Cross-platform build pipeline
- `docs/v2/PERFORMANCE.md` — Performance & stability guide - `docs/PERFORMANCE.md` — Performance & stability guide
### Architecture Decision ### Architecture Decision
- Backend: GoFiber v2 (fasthttp-based) replacing chi/net/http - Backend: GoFiber v2 (fasthttp-based) replacing chi/net/http
README.md
+2 -3
View File
@@ -22,7 +22,7 @@ V2 adalah rewrite dengan arsitektur baru:
- **Desktop**: Electron wrapper di `app/electron/` - **Desktop**: Electron wrapper di `app/electron/`
- **Mobile**: WebView shell di `mobile/` - **Mobile**: WebView shell di `mobile/`
Lihat [docs/v2/](docs/v2/) untuk dokumentasi perencanaan. Lihat [docs/](docs/) untuk dokumentasi perencanaan.
## Struktur Repository ## Struktur Repository
@@ -32,8 +32,7 @@ hostkeeper/
├── app/ ← V2 backend + frontend + electron ├── app/ ← V2 backend + frontend + electron
├── mobile/ ← V2 mobile wrapper ├── mobile/ ← V2 mobile wrapper
├── template/ ← Referensi UI React (Lumina System) ├── template/ ← Referensi UI React (Lumina System)
└── docs/ └── docs/ ← Dokumentasi perencanaan V2
└── v2/ ← Dokumentasi perencanaan V2
``` ```
## License ## License
docs/v2/API.md → docs/API.md
View File
docs/v2/ARCHITECTURE.md → docs/ARCHITECTURE.md
+26 -23
View File
@@ -189,31 +189,34 @@ hostkeeper/
│ ├── build-electron.sh # Electron package │ ├── build-electron.sh # Electron package
│ └── build-mobile.sh # Mobile build │ └── build-mobile.sh # Mobile build
│ │
├── docs/ # Documentation ├── docs/ # Documentation (V2 planning)
│ ├── v2/ # V2 planning docs │ ├── PROGRESS.md # Status tracker (read this first)
│ │ ├── PROGRESS.md # Status tracker (read this first) │ ├── ARCHITECTURE.md # This file
│ │ ├── ARCHITECTURE.md # This file │ ├── API.md # REST API + WebSocket spec
│ │ ├── API.md # REST API + WebSocket spec │ ├── DATA_MODELS.md # Extended data models
│ │ ├── DATA_MODELS.md # Extended data models │ ├── UI_COMPONENTS.md # React component tree
│ │ ├── UI_COMPONENTS.md # React component tree │ ├── UI_TERMIUS_REFERENCE.md # Termius visual reference
│ │ ├── UI_TERMIUS_REFERENCE.md # Termius visual reference │ ├── SPRINT_PLAN.md # Sprint-by-sprint task breakdown
│ │ ├── SPRINT_PLAN.md # Sprint-by-sprint task breakdown │ ├── BUILD_SYSTEM.md # Build pipeline
│ │ ├── BUILD_SYSTEM.md # Build pipeline │ ├── PERFORMANCE.md # Performance & stability
│ │ └── PERFORMANCE.md # Performance & stability │ └── TIMELINE.md # Project timeline
│ ├── v1/ # V1 docs (FROZEN, reference only)
│ │ ├── ARCHITECTURE.md
│ │ ├── TEST_PLAN.md
│ │ ├── INSTALLATION.md
│ │ └── USAGE.md
│ └── plans/ # V1 design docs (FROZEN)
│ │
├── go.mod # V1 Go module
├── go.sum
├── Makefile
├── build.sh
├── CHANGELOG.md ├── CHANGELOG.md
├── PROJECT_STATE.md # V1 project state ├── README.md
└── README.md ├── AGENTS.md # AI session checkpoint
├── v1/ # V1 CLI/TUI (FROZEN)
│ ├── cmd/hostkeeper/
│ ├── internal/
│ ├── pkg/
│ ├── test/
│ ├── docs/ # V1 docs
│ ├── go.mod
│ └── Makefile
├── template/ # React UI template (Lumina System)
└── app/ # V2 app (scaffolding not started)
├── backend/
├── frontend/
└── electron/
``` ```
--- ---
docs/v2/BUILD_SYSTEM.md → docs/BUILD_SYSTEM.md
View File
docs/v2/DATA_MODELS.md → docs/DATA_MODELS.md
View File
docs/v2/PERFORMANCE.md → docs/PERFORMANCE.md
View File
docs/v2/PROGRESS.md → docs/PROGRESS.md
+17 -17
View File
@@ -290,15 +290,15 @@ Hostkeeper V2 is a Termius-like cross-platform SSH/SFTP management GUI applicati
### For a new AI agent: ### For a new AI agent:
1. **Read this file** (`docs/v2/PROGRESS.md`) — find the first `[ ]` item 1. **Read this file** (`docs/PROGRESS.md`) — find the first `[ ]` item
2. **Read the relevant spec doc** — for the current task: 2. **Read the relevant spec doc** — for the current task:
- REST API endpoints -> `docs/v2/API.md` - REST API endpoints -> `docs/API.md`
- UI components -> `docs/v2/UI_COMPONENTS.md` - UI components -> `docs/UI_COMPONENTS.md`
- Data models -> `docs/v2/DATA_MODELS.md` - Data models -> `docs/DATA_MODELS.md`
- Visual reference -> `docs/v2/UI_TERMIUS_REFERENCE.md` - Visual reference -> `docs/UI_TERMIUS_REFERENCE.md`
- Performance notes -> `docs/v2/PERFORMANCE.md` - Performance notes -> `docs/PERFORMANCE.md`
- Build pipeline -> `docs/v2/BUILD_SYSTEM.md` - Build pipeline -> `docs/BUILD_SYSTEM.md`
3. **Read `docs/v2/ARCHITECTURE.md`** — understand the system 3. **Read `docs/ARCHITECTURE.md`** — understand the system
4. **Implement** in `app/backend/` (Go) or `app/frontend/` (React) 4. **Implement** in `app/backend/` (Go) or `app/frontend/` (React)
5. **Test** — run `go test ./app/backend/...` and `npm test` in `app/frontend/` 5. **Test** — run `go test ./app/backend/...` and `npm test` in `app/frontend/`
6. **Update this file** — mark `[x]` the completed task, update "Last Session Notes" 6. **Update this file** — mark `[x]` the completed task, update "Last Session Notes"
@@ -316,15 +316,15 @@ Hostkeeper V2 is a Termius-like cross-platform SSH/SFTP management GUI applicati
| Document | When to read | | Document | When to read |
|----------|-------------| |----------|-------------|
| `docs/v2/PROGRESS.md` | Always (first) — know where to continue | | `docs/PROGRESS.md` | Always (first) — know where to continue |
| `docs/v2/ARCHITECTURE.md` | Understanding the system | | `docs/ARCHITECTURE.md` | Understanding the system |
| `docs/v2/API.md` | Implementing REST endpoints or WebSocket handlers | | `docs/API.md` | Implementing REST endpoints or WebSocket handlers |
| `docs/v2/DATA_MODELS.md` | Creating/modifying Go structs or JSON schemas | | `docs/DATA_MODELS.md` | Creating/modifying Go structs or JSON schemas |
| `docs/v2/UI_COMPONENTS.md` | Building React components | | `docs/UI_COMPONENTS.md` | Building React components |
| `docs/v2/UI_TERMIUS_REFERENCE.md` | Designing UI layout, colors, typography | | `docs/UI_TERMIUS_REFERENCE.md` | Designing UI layout, colors, typography |
| `docs/v2/SPRINT_PLAN.md` | Detailed file-by-file task instructions | | `docs/SPRINT_PLAN.md` | Detailed file-by-file task instructions |
| `docs/v2/BUILD_SYSTEM.md` | Setting up build pipeline | | `docs/BUILD_SYSTEM.md` | Setting up build pipeline |
| `docs/v2/PERFORMANCE.md` | Tuning for speed and stability | | `docs/PERFORMANCE.md` | Tuning for speed and stability |
--- ---
docs/v2/SPRINT_PLAN.md → docs/SPRINT_PLAN.md
View File
docs/v2/TIMELINE.md → docs/TIMELINE.md
+1 -1
View File
@@ -298,7 +298,7 @@ Thu 7: [Release] v2.0.0 ← M6
**How to update this timeline**: **How to update this timeline**:
1. At the end of each day, mark `[x]` for completed tasks 1. At the end of each day, mark `[x]` for completed tasks
2. If a task takes longer, adjust subsequent dates 2. If a task takes longer, adjust subsequent dates
3. Update `docs/v2/PROGRESS.md` with actual completion dates 3. Update `docs/PROGRESS.md` with actual completion dates
```markdown ```markdown
### Week 1 Progress ### Week 1 Progress
docs/v2/UI_COMPONENTS.md → docs/UI_COMPONENTS.md
View File
docs/v2/UI_TERMIUS_REFERENCE.md → docs/UI_TERMIUS_REFERENCE.md
View File