Skip to content

Commit 08a7cca

Browse files
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

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

client/cmd/genhelp/gen_help.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ func GenGroupHelp(writer io.Writer, con *core.Console, groupId string, binds ...
194194
}
195195

196196
func GenImplantHelp(con *core.Console) {
197-
implantMd, err := os.Create("implant_template.md")
197+
implantMd, err := os.Create("docs/reference/commands/implant.md")
198198
if err != nil {
199199
panic(err)
200200
}
@@ -230,7 +230,7 @@ func GenImplantHelp(con *core.Console) {
230230
}
231231

232232
func GenClientHelp(con *core.Console) {
233-
clientMd, err := os.Create("client_template.md")
233+
clientMd, err := os.Create("docs/reference/commands/client.md")
234234
if err != nil {
235235
panic(err)
236236
}
@@ -261,7 +261,7 @@ func GenClientHelp(con *core.Console) {
261261
}
262262

263263
func GenMalHelper(con *core.Console, name string) {
264-
clientMd, err := os.Create(name + ".md")
264+
clientMd, err := os.Create("docs/reference/commands/" + name + ".md")
265265
if err != nil {
266266
panic(err)
267267
}

client/cmd/genlua/gen_lua.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func main() {
3939
mals.GenerateLuaDefinitionFile(vm, intermediate.RpcPackage, plugin.ProtoPackage, intermediate.InternalFunctions.Package(intermediate.RpcPackage))
4040
mals.GenerateLuaDefinitionFile(vm, intermediate.BeaconPackage, plugin.ProtoPackage, intermediate.InternalFunctions.Package(intermediate.BeaconPackage))
4141

42-
mals.GenerateMarkdownDefinitionFile(vm, intermediate.BuiltinPackage, "builtin.md", intermediate.InternalFunctions.Package(intermediate.BuiltinPackage))
43-
mals.GenerateMarkdownDefinitionFile(vm, intermediate.RpcPackage, "rpc.md", intermediate.InternalFunctions.Package(intermediate.RpcPackage))
44-
mals.GenerateMarkdownDefinitionFile(vm, intermediate.BeaconPackage, "beacon.md", intermediate.InternalFunctions.Package(intermediate.BeaconPackage))
42+
mals.GenerateMarkdownDefinitionFile(vm, intermediate.BuiltinPackage, "docs/reference/lua-api/builtin.md", intermediate.InternalFunctions.Package(intermediate.BuiltinPackage))
43+
mals.GenerateMarkdownDefinitionFile(vm, intermediate.RpcPackage, "docs/reference/lua-api/rpc.md", intermediate.InternalFunctions.Package(intermediate.RpcPackage))
44+
mals.GenerateMarkdownDefinitionFile(vm, intermediate.BeaconPackage, "docs/reference/lua-api/beacon.md", intermediate.InternalFunctions.Package(intermediate.BeaconPackage))
4545
}

docs/architecture.md

Lines changed: 0 additions & 130 deletions
This file was deleted.
223 KB
10.7 KB
5.67 KB
58.7 KB
42.8 KB
13.6 KB
41.7 KB

0 commit comments

Comments
 (0)