hs-sql-agent 目前可分成 backend、Admin frontend,以及獨立的 static product/documentation site。
Repository responsibility
高層次來看:
backend/:server、SQL compiler/runtime modules、persistence 與 tests。frontend/:embedded Nuxt Admin Panel。hs-sql-agent.site:獨立 Astro product/documentation site。
SQL compiler 含有 F# modules 與明確 rewrite/validation stage、capability-proof 概念。Server hosting 由 HsSqlAgent.Server 以 composable ASP.NET Core class library 形式提供:新整合從 AddHsSqlAgentCore() 開始,再選 Runtime、AdminStore、HostAuthorization 或 BuiltInAuth、AdminApi、MCP、Telemetry 等 capabilities。AddHsSqlAgent() / UseHsSqlAgent() 保留給既有 consumer 相容,不再是第一方推薦 integration model。
Contribution flow
Main repository contribution guide 要求 contributor:
- Fork repository。
- 實作 focused change,補上需要的 test 或 docs。
- Local run 並確認 tests。
- 開 Pull Request,說明 motivation、change 與 testing evidence。
讓一個 PR 聚焦在單一 task,通常更容易 review / merge。
Documentation change
Docs 應描述 current code behavior,而不是尚未實作的預期功能。
SQL capability、DML safety、MCP compatibility、hosting config、Admin behavior 或 deployment requirement 改變時,應同步更新對應 docs。
Site 使用 path-based locale 與 documentation version:
src/content/en/docs/<version>/<section>/<slug>.mdx
src/content/zh-hant/docs/<version>/<section>/<slug>.mdx
兩種語言刻意共用相同 version/section/slug,再由 locale-prefixed route 隔離。目前完整 documentation baseline 為 2.0.2。