Commit 08a7cca
committed
docs: restructure and migrate documentation system
Complete documentation reorganization with clear responsibility boundaries:
- client/: mechanism, architecture, design (console, plugin, agent)
- server/: architecture, config reference, internals (RPC, DB, audit, LLM)
- operations/: user-facing operation guides (deployment, listener, build, proxy, post-exploitation, advanced)
- development/: contributor guides (contributing, protocol, SDK, MAL, AI integration)
- reference/: auto-generated command reference and Lua API
Key changes:
Architecture:
- Rename all README.md to index.md for Material for MkDocs
- Split post-exploitation.md (1,566 lines) into 10 functional files
- Migrate IoM wiki content (guideline/, manual/, integrate/)
- Create reference/ with auto-generated docs via genhelp/genlua
Client docs (5 files):
- quickstart.md, console.md, plugin.md, agent.md, index.md
- Command groups table links to operations/ for concrete usage
Server docs (5 files):
- quickstart.md, listeners.md, build.md, internals.md, index.md
- Complete config.yaml reference with all fields documented
Operations docs (22 files):
- Deployment, listener, build, proxy, embed-mal guides
- Post-exploitation split: session/task/module/exec/sys/service/wmi/reg/file/network
- Advanced: domain-fronting, dump-lsass, guardrail, multi-server
Development docs (10+ files):
- contributing.md: env setup, Command/RPC development, PR workflow
- ai-integration.md: MCP, SDK as AI Tool, FFI
- protocol/: gRPC services, Spite protocol, Parser mechanism
- sdk/: Go, Python, TypeScript SDK guides
- mal/: complete MAL plugin development docs
Reference docs (auto-generated):
- commands/: client.md, implant.md, community.md
- lua-api/: builtin.md, rpc.md, beacon.md
- genhelp output → docs/reference/commands/
- genlua output → docs/reference/lua-api/
Code changes:
- client/cmd/genhelp: output to docs/reference/commands/
- client/cmd/genlua: markdown output to docs/reference/lua-api/
Image assets: 33MB migrated from IoM wiki to docs/assets/
All TODO links resolved (30+ occurrences → 0 remaining)1 parent d305cf4 commit 08a7cca
266 files changed
Lines changed: 18786 additions & 700 deletions
File tree
- client/cmd
- genhelp
- genlua
- docs
- assets
- advance/usage/domain_front
- embed/usage
- common
- domain
- usage
- build
- deploy
- implant
- listener
- lsass
- client
- development
- mal
- protocol
- sdk
- experiments
- implant
- operations
- advanced
- post-exploitation
- reference
- commands
- lua-api
- server
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
194 | 194 | | |
195 | 195 | | |
196 | 196 | | |
197 | | - | |
| 197 | + | |
198 | 198 | | |
199 | 199 | | |
200 | 200 | | |
| |||
230 | 230 | | |
231 | 231 | | |
232 | 232 | | |
233 | | - | |
| 233 | + | |
234 | 234 | | |
235 | 235 | | |
236 | 236 | | |
| |||
261 | 261 | | |
262 | 262 | | |
263 | 263 | | |
264 | | - | |
| 264 | + | |
265 | 265 | | |
266 | 266 | | |
267 | 267 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
43 | | - | |
44 | | - | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
45 | 45 | | |
This file was deleted.
0 commit comments