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
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-mobile.sh # Mobile build
│
├── docs/ # Documentation
│ ├── v2/ # V2 planning docs
│ │ ├── PROGRESS.md # Status tracker (read this first)
│ │ ├── ARCHITECTURE.md # This file
│ │ ├── API.md # REST API + WebSocket spec
│ │ ├── DATA_MODELS.md # Extended data models
│ │ ├── UI_COMPONENTS.md # React component tree
│ │ ├── UI_TERMIUS_REFERENCE.md # Termius visual reference
│ │ ├── SPRINT_PLAN.md # Sprint-by-sprint task breakdown
│ │ ├── BUILD_SYSTEM.md # Build pipeline
│ │ └── PERFORMANCE.md # Performance & stability
│ ├── v1/ # V1 docs (FROZEN, reference only)
│ │ ├── ARCHITECTURE.md
│ │ ├── TEST_PLAN.md
│ │ ├── INSTALLATION.md
│ │ └── USAGE.md
│ └── plans/ # V1 design docs (FROZEN)
├── docs/ # Documentation (V2 planning)
│ ├── PROGRESS.md # Status tracker (read this first)
│ ├── ARCHITECTURE.md # This file
│ ├── API.md # REST API + WebSocket spec
│ ├── DATA_MODELS.md # Extended data models
│ ├── UI_COMPONENTS.md # React component tree
│ ├── UI_TERMIUS_REFERENCE.md # Termius visual reference
│ ├── SPRINT_PLAN.md # Sprint-by-sprint task breakdown
│ ├── BUILD_SYSTEM.md # Build pipeline
│ ├── PERFORMANCE.md # Performance & stability
│ └── TIMELINE.md # Project timeline
│
├── go.mod # V1 Go module
├── go.sum
├── Makefile
├── build.sh
├── 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:
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:
- REST API endpoints -> `docs/v2/API.md`
- UI components -> `docs/v2/UI_COMPONENTS.md`
- Data models -> `docs/v2/DATA_MODELS.md`
- Visual reference -> `docs/v2/UI_TERMIUS_REFERENCE.md`
- Performance notes -> `docs/v2/PERFORMANCE.md`
- Build pipeline -> `docs/v2/BUILD_SYSTEM.md`
3. **Read `docs/v2/ARCHITECTURE.md`** — understand the system
- REST API endpoints -> `docs/API.md`
- UI components -> `docs/UI_COMPONENTS.md`
- Data models -> `docs/DATA_MODELS.md`
- Visual reference -> `docs/UI_TERMIUS_REFERENCE.md`
- Performance notes -> `docs/PERFORMANCE.md`
- Build pipeline -> `docs/BUILD_SYSTEM.md`
3. **Read `docs/ARCHITECTURE.md`** — understand the system
4. **Implement** in `app/backend/` (Go) or `app/frontend/` (React)
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"
@@ -316,15 +316,15 @@ Hostkeeper V2 is a Termius-like cross-platform SSH/SFTP management GUI applicati
| Document | When to read |
|----------|-------------|
| `docs/v2/PROGRESS.md` | Always (first) — know where to continue |
| `docs/v2/ARCHITECTURE.md` | Understanding the system |
| `docs/v2/API.md` | Implementing REST endpoints or WebSocket handlers |
| `docs/v2/DATA_MODELS.md` | Creating/modifying Go structs or JSON schemas |
| `docs/v2/UI_COMPONENTS.md` | Building React components |
| `docs/v2/UI_TERMIUS_REFERENCE.md` | Designing UI layout, colors, typography |
| `docs/v2/SPRINT_PLAN.md` | Detailed file-by-file task instructions |
| `docs/v2/BUILD_SYSTEM.md` | Setting up build pipeline |
| `docs/v2/PERFORMANCE.md` | Tuning for speed and stability |
| `docs/PROGRESS.md` | Always (first) — know where to continue |
| `docs/ARCHITECTURE.md` | Understanding the system |
| `docs/API.md` | Implementing REST endpoints or WebSocket handlers |
| `docs/DATA_MODELS.md` | Creating/modifying Go structs or JSON schemas |
| `docs/UI_COMPONENTS.md` | Building React components |
| `docs/UI_TERMIUS_REFERENCE.md` | Designing UI layout, colors, typography |
| `docs/SPRINT_PLAN.md` | Detailed file-by-file task instructions |
| `docs/BUILD_SYSTEM.md` | Setting up build pipeline |
| `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**:
1. At the end of each day, mark `[x]` for completed tasks
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
### 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