Where to Find DeepSeek-Reasonix Documentation: Complete Guide to Guides, CLI Reference, and SDK Docs

DeepSeek-Reasonix documentation lives entirely within the repository under the docs/ directory, with all entry points linked from the root README.md at lines 77-85.

The esengine/DeepSeek-Reasonix project bundles every guide, specification, and API reference alongside its source code. This ensures version parity—your documentation always matches your binary. Whether you need quick CLI commands, deep architectural specs, or Go SDK examples, everything is reachable without external sites.

---

Main Documentation Entry Points in docs/

All core documentation resides in the top-level docs/ folder. Each file targets a specific use case or integration path.

High-Level Guides and Concepts

Document	Purpose	Key Contents
docs/GUIDE.md	Getting-started overview	Installation, concepts, first session
docs/CONFIG_PATHS.md	Runtime configuration	TOML file locations, environment variables, data directories

Command-Line and Runtime References

Document	Purpose	Key Contents
docs/CLI.md	Full CLI specification	Flags, subcommands, TUI shortcuts
docs/SPEC.md	Formal protocol definition	Sub-agents, checkpoints, message flow

Integration and Extension Docs

Document	Purpose	Key Contents
docs/ACP.md	VS Code/editor integration	Agent-Code-Protocol setup
docs/EXTENSIONS.md	Plugin development	Building and publishing extensions
docs/EXTENSION_PROTOCOL.md	Extension mechanics	Protocol details for plugin communication
docs/PLUGIN_PACKAGES.md	Package manifest format	reasonix.toml schema for plugins

Contract and Schema References

Document	Purpose	Key Contents
docs/TOOL_CONTRACT.md	Built-in tool schema	Validation rules for tool calls
docs/TASK_CONTRACT.md	Task lifecycle spec	Pause policy, checkpoint handling, state transitions

---

SDK and Platform-Specific Documentation

Beyond the main docs/ folder, specialized documentation lives with its source code.

Go SDK Documentation

The sdk/go/README.md provides the complete API reference for writing Go extensions. This includes:

• Provider interface implementation
• Request/response type definitions from types_generated
• Starter project template

package main

import (
    "github.com/esengine/DeepSeek-Reasonix/sdk/go"
    "github.com/esengine/DeepSeek-Reasonix/sdk/go/types_generated"
)

func main() {
    // Create a new provider that implements a tool
    p := &sdk.Provider{
        Name: "my-tool",
        Run: func(req *types_generated.Request) (*types_generated.Response, error) {
            // …custom logic…
            return &types_generated.Response{Content: "ok"}, nil
        },
    }
    // Register the provider with Reasonix
    sdk.RegisterProvider(p)

    // Start the agent (normally started by the runtime)
    sdk.Start()
}

Desktop Application Documentation

Build and run instructions for the Wails-based desktop app are in desktop/README.md. This covers:

• Platform-specific compilation
• Development server setup
• Packaging for distribution

---

Critical Root-Level Files

Several files outside docs/ serve as architectural and configuration references.

File	Location	Role
README.md	Repository root	Central hub with installation links, feature list, and documentation shortcuts (lines 77-85)
REASONIX.md	Repository root	Core design document: agent architecture, sub-agents, checkpoint model
reasonix.example.toml	Repository root	Annotated configuration template showing providers, tools, and workspace settings

---

Quick Reference: Where to Start Based on Your Goal

1. First-time setup → docs/GUIDE.md and README.md lines 77-85
2. CLI command lookup → docs/CLI.md
3. Writing a custom tool → sdk/go/README.md and docs/EXTENSIONS.md
4. Understanding checkpoint behavior → docs/SPEC.md and REASONIX.md
5. Configuring providers → docs/CONFIG_PATHS.md and reasonix.example.toml

---

Summary

• All DeepSeek-Reasonix documentation is version-controlled in the repository—no external doc site required
• Primary location: docs/ folder with 9 specialized markdown files
• Entry point: README.md lines 77-85 contains the master documentation index
• SDK docs: sdk/go/README.md for Go extension development
• Desktop docs: desktop/README.md for application builds
• Architecture deep-dive: REASONIX.md for agent internals and checkpoint semantics

---

Frequently Asked Questions

Does DeepSeek-Reasonix have a separate documentation website?

No. All documentation is maintained as markdown files inside the repository. The README.md at the repository root links to every guide, and because docs are version-controlled with the code, they automatically match whichever commit or release you have checked out.

How do I find documentation for my specific version?

Since documentation files live in the same Git tree as source code, checking out any tag or branch gives you the exact docs for that version. For example, git checkout v2.1.0 updates both the binary source and all /docs files simultaneously.

What is the difference between docs/SPEC.md and REASONIX.md?

docs/SPEC.md provides the formal protocol specification for implementing compatible agents and tools, while REASONIX.md is the architectural design document explaining why those specifications exist—covering sub-agent composition, checkpoint persistence, and reasoning strategies.

Where do I look for plugin development help beyond the Go SDK?

Start with docs/EXTENSIONS.md for the extension overview, then consult docs/EXTENSION_PROTOCOL.md for wire-level details and docs/PLUGIN_PACKAGES.md for packaging your plugin with a reasonix.toml manifest.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}