XNCF Module Documentation Map

Coverage audit performed on 2026-08-14 against the NcfPackageSources development line. This is a documentation coverage map, not a statement that a module is unsupported or unsuitable for production.

The complete project-level audit for NcfPackageSources_Include_NcfSimulatedSite.sln is maintained in the Solution Project Map. Every runtime project in that solution has a beginner-facing introduction there; this page tracks the remaining need for deeper, module-specific source analysis.

NCF has two legitimate audiences, and one document type cannot serve both well:

ReaderNeeds firstDocumentation type
Template/application userWhat to install, configure, authorize, operate, and verifyModule usage guide
NcfPackageSources contributorRegister/lifecycle, AppService path, persistence, key methods, extension constraintsModule source analysis

A user of a NuGet/template project should not have to locate implementation files. Conversely, a source contributor needs more than an Admin-menu tour. New module documents should therefore lead with the usage guide and link to a separate source-analysis page when source depth is needed.

Current Detailed Coverage

Module / capabilityUsage guideSource analysisNotes
Senparc.Xncf.XncfBuilderYesYesCreate/edit/preview/review/merge boundary.
Senparc.Xncf.SandboxEnvironment setupIncluded in the XncfBuilder/Sandbox integration analysisDocker preparation and fixed NCF preview workload.
Senparc.Xncf.AIKernelLocal fine-tuningWorker contract and lifecycle covered in the usage guide; broader model/vector internals remain a gapSFT/LoRA/QLoRA, offline models, datasets, deployment, evaluation, and operator boundaries.
Senparc.Xncf.NeuCharWorkflowOperator guideIntegrated, node-level analysisTriggers, nodes, restricted expressions, replay.
Senparc.Xncf.AgentsManagerHIL and Workflow integration, 3D status viewIntegration and runtime view coveredAgent / Group / A2A HIL requests, 3D status, skill markers, and spatial-layout boundaries.
Senparc.Xncf.MCPDedicated guidesPartial common-register analysisInstallation, use, API, FAQ exist; module internals still need a focused page.
Senparc.Web / Senparc.Areas.AdminHost and Admin guideHost composition and Admin boundaryRun, install, sign in, module enablement, and source ownership.
XNCF framework / custom moduleTemplate developmentCapability guideFramework-level rather than one official module.

The project map now covers every runtime project in the target solution. The following backlog is intentionally narrower: it identifies modules that need a dedicated deep-dive page beyond their complete project-map introduction.

Complete Module Inventory and Documentation Backlog

P0 — Module Governance and Platform Baseline

These modules should be documented first because every installed module depends on their lifecycle, menu, authorization, or tenant assumptions.

ModuleMissing essential guide content
Senparc.Xncf.XncfModuleManagerUsage: discovery/install/open/close/function diagnostics. Source: module state transition, register scan, AI-friendly install action.
Senparc.Xncf.SystemCoreUsage: required baseline data and installation order. Source: DbContext/factory registration and system entity lifecycle.
Senparc.Xncf.SystemManagerUsage: system configuration and operational dependencies. Source: configuration read/write boundaries and background services.
Senparc.Xncf.SystemPermissionUsage: role/permission administration. Source: policy mapping, authorization checks, and admin scope.
Senparc.Xncf.MenuUsage: menu administration. Source: menu registration and localization path.
Senparc.Xncf.TenantUsage: tenant enablement/isolation. Source: tenant resolution and IIgnoreMulitTenant exceptions.
Senparc.Xncf.AreasBaseSource: Area baseline conventions and its relationship with Senparc.Ncf.AreaBase.

P1 — AI, Prompt, Agent, and Knowledge Chain

These modules should be documented as one end-to-end operational journey, while keeping their source pages separate enough to explain their different data and execution models.

ModuleMissing essential guide content
Senparc.Xncf.AIKernelLocal fine-tuning is covered. Remaining: general model/vector provider configuration, credential ownership, inference model selection, and source service selection.
Senparc.Xncf.PromptRangePrompt asset/PromptCode lifecycle, version/range selection; source AppService/events and storage model.
Senparc.Xncf.AgentsManagerAgent template, ChatGroup, task and A2A usage; source task runner, participant resolution, streaming/error boundaries.
Senparc.Xncf.KnowledgeBaseImport/embedding/recall operations and data-retention expectations; source resource policy, chunk/embedding lifecycle.
Senparc.Xncf.MCPAdd a source page for endpoint mapping, Function exposure, auth/rate-limit/audit boundary.
Senparc.Xncf.AIAgentsHubState the current maturity, supported integrations, and intentionally unsupported scenarios before promoting use.

P1 — Operations, Development, and High-Risk Capabilities

Each of these needs a usage page with permissions, rollback, and production constraints before a source deep dive.

ModuleMissing essential guide content
Senparc.Xncf.DatabaseToolkitBackup/update/query permissions, multi-database scope, transaction/rollback limits, AI query boundary.
Senparc.Xncf.FileManagerUpload/storage/resource-purpose policy, public versus knowledge-base assets, path traversal boundary.
Senparc.Xncf.DesktopBridgePairing, bridge token rotation, SSE lifecycle, desktop compatibility and network boundary.
Senparc.Xncf.FirmwareUpdateFeed/mirror configuration, rate-limit/backoff behavior, manual versus background sync, failure isolation.
Senparc.Xncf.TerminalStrict operator-only usage, command allow-list/audit/host privilege model; source command execution path.
Senparc.Xncf.SwaggerEnablement, route exposure and production auth policy.
Senparc.Xncf.DynamicDataCurrent maturity and supported dynamic-data boundaries.

P2 — Integration, Communications, and Utility Modules

These need concise task-oriented guides first, then source analysis as their contract surface becomes stable.

ModuleMissing essential guide content
Senparc.Xncf.WeixinManagerAccount/app configuration, credential protection, message/API lifecycle, optional MCP exposure.
Senparc.Xncf.DaprEnablement, component prerequisites, local versus cluster behavior, retry/observability boundary.
Senparc.Xncf.ApplicationExternal-program registration, host permissions, timeout/logging and rollback.
Senparc.Xncf.SenMapicCrawler target policy, rate limiting, legal/operational constraints, sample status.

Recommended Page Shape for Every Module

1. Usage guide: works without source access

  1. Purpose, maturity, dependencies, and non-goals.
  2. Install/enable/configure/authorize steps.
  3. One normal workflow and one failure/rollback workflow.
  4. Security and production checklist: secrets, permissions, network, resource limits, audit, and data retention.
  5. Troubleshooting order and links to related modules.

2. Source analysis: supports contributors

  1. Project/layer map: Register, Register.Area, Register.Database, Domain, Application, OHS, Areas, resources, and tests.
  2. Register metadata, lifecycle hooks, DbContext/migration ownership, and module dependencies.
  3. Key AppService entry points, domain services, background jobs/events, and request/data flow.
  4. Critical methods with input validation, authorization, concurrency, failure handling, and extension constraints.
  5. Test seam and a short change checklist that protects public contracts.

Maintenance Rule

Whenever a module changes any of the following, update its two pages or add an explicitly labelled gap to this map:

  • Register version/order, installation state, or module dependency;
  • public FunctionRender/MCP surface or AI invocation eligibility;
  • authorization/policy, secret handling, network, or data-retention behavior;
  • migration/database model, background job, or external-service contract;
  • a user-visible workflow, rollback path, or operational requirement.

Reading Routes