> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/documentation/en/zongsoft-framework.md).

# Zongsoft Framework

English documentation for the Zongsoft framework, hosts, and toolchain.

![Zongsoft documentation cover](https://1509929121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVtPQeWxVwz4p7FTcxkG8%2Fuploads%2Fgit-blob-5a6f8c458b365c1c82a9ace6f706ae6fe84c17cb%2Fzongsoft-docs-cover.png?alt=media)

Zongsoft is a collection of open-source frameworks, hosts, and development tools for .NET. It helps teams build business applications that are extensible through plugins, straightforward to deploy, and maintainable.

The documentation covers:

{% columns %}
{% column %}

### Framework

[Core](https://github.com/Zongsoft/framework/tree/main/Zongsoft.Core) abstractions, the plugin framework, the data engine, Web fundamentals, security, diagnostics, messaging, automatic upgrades, and adapters for common third-party services.
{% endcolumn %}

{% column %}

### Hosts and Tools

Hosts run plugin-based applications. The toolchain deploys plugins, builds installation packages, publishes upgrade packages, and supports development and debugging.
{% endcolumn %}
{% endcolumns %}

## Quick Navigation

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref">Page</th><th data-hidden data-card-cover data-type="image">Cover</th></tr></thead><tbody><tr><td><strong>Understand the overall design</strong></td><td>Build the big picture starting from the boundaries of the framework, host, and toolchain.</td><td><a href="/documentation/en/overview/what-is-zongsoft.md">What Is Zongsoft?</a></td><td><a href="https://1509929121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVtPQeWxVwz4p7FTcxkG8%2Fuploads%2Fgit-blob-5a6f8c458b365c1c82a9ace6f706ae6fe84c17cb%2Fzongsoft-docs-cover.png?alt=media">zongsoft-docs-cover.png</a></td></tr><tr><td><strong>Prepare Your Local Environment</strong></td><td>Prepare the SDK, source repositories, directories, and optional containers.</td><td><a href="/documentation/en/get-started/prerequisites.md">Prerequisites</a></td><td><a href="https://1509929121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVtPQeWxVwz4p7FTcxkG8%2Fuploads%2Fgit-blob-10be71c1aee0af4b6e8f004be7e2c5ffeb32b5e9%2Fzongsoft-start-cover.png?alt=media">zongsoft-start-cover.png</a></td></tr><tr><td><strong>Understand Plugin-Based Applications</strong></td><td>Explore the plugin tree, builtins, service registration, and host integration.</td><td><a href="/documentation/en/framework/plugins.md">Plugin Framework</a></td><td><a href="https://1509929121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVtPQeWxVwz4p7FTcxkG8%2Fuploads%2Fgit-blob-9196bec8b8df6c12712d5b0dd515deeb0d57f7cf%2Fzongsoft-plugins-cover.png?alt=media">zongsoft-plugins-cover.png</a></td></tr><tr><td><strong>Learn data access</strong></td><td>Read and write object graphs using data schemas, mapping files, and drivers.</td><td><a href="/documentation/en/framework/data.md">Data Engine</a></td><td><a href="https://1509929121-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVtPQeWxVwz4p7FTcxkG8%2Fuploads%2Fgit-blob-4bba74b4b746d0421774fe57bfbad6ef4524fa51%2Fzongsoft-data-cover.png?alt=media">zongsoft-data-cover.png</a></td></tr></tbody></table>

## Reading Path

If you are new to Zongsoft, follow this reading path:

1. Start with [What Is Zongsoft?](/documentation/en/overview/what-is-zongsoft.md) to understand the overall scope.
2. Read [Plugin Architecture](/documentation/en/overview/pluginization.md) to understand why business capabilities are organized as plugins.
3. Follow [Prerequisites](/documentation/en/get-started/prerequisites.md) and [Install Packages](/documentation/en/get-started/install.md) to prepare your local environment.
4. [Choose a Host](/documentation/en/get-started/hosting.md), complete a [minimal deployment](/documentation/en/get-started/deploy-first-plugin.md), and write [your first business plugin](/documentation/en/get-started/first-business-plugin.md).
5. Continue with the framework guides, choosing the core library, plugin framework, data engine, Web fundamentals, or other topics as needed.

{% hint style="info" %}
These guides follow the process of building a plugin-based application. For package names, source paths, and module relationships, see the [Package and Module Index](/documentation/en/references/packages.md).
{% endhint %}

## Explore by Need

* To define module boundaries, design extension contracts, or evolve an existing system, read the [Plugin Design Essays](/documentation/en/overview/pluginization.md#plugin-design-essays).
* To understand hosts, modules, services, and providers, read [Core Concepts](/documentation/en/overview/concepts.md) and [Service Resolution](/documentation/en/framework/core/services/locating.md).
* For business data and HTTP APIs, start with [your first query](/documentation/en/framework/data/quickstart.md), continue to [Data Services](/documentation/en/framework/data/services.md), and then add [Web Controllers](/documentation/en/framework/web/controllers.md).
* For asynchronous work and external infrastructure, read [Message Delivery Concepts](/documentation/en/framework/messaging/concepts.md), [Task Scheduling](/documentation/en/framework/externals/execution.md), and the [Extension Index](/documentation/en/framework/externals.md).
* For model calls, observability, or application delivery, explore [AI Integration](/documentation/en/framework/intelligences.md), [Diagnostics](/documentation/en/framework/diagnostics.md), and the [Upgrade Workflow](/documentation/en/framework/upgrading/workflow.md).

{% hint style="info" %}
Verbatim source excerpts retain their original comments and literal values, including Chinese text, so they can be checked against the linked source. Page explanations and navigation are translated into English.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/zongsoft-framework.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.