Skip to main content

Docs library

Use this page to jump into the manual that matches what you are trying to do in Suora.

User deep divesBrowse site-level deep-dive pages for the 10 workbench modules.Technical deep divesBrowse site-level technical deep-dive pages for route, state, service, and safety anchors.READMEProject overview, routes, provider support, primary docs, and release workflow.FEATURES.mdImplementation-backed summary of product capabilities.Technical docs (EN)Architecture, service boundaries, and implementation details.Module architecture guide (EN)Module-by-module technical handbook with route, state, service, persistence, and test anchors.LLM Wiki capability referenceDocument-intelligence ideas from nashsu/llm_wiki, kept separate from shipped features.User guide (EN)Installation, first-run, and module-by-module usage guidance.Module playbook (EN)Module-by-module user handbook with staged workflow questions and answers.Technical docs (ZH)Chinese technical documentation for the same implementation surface.Module architecture guide (ZH)Chinese module-by-module technical handbook.User guide (ZH)Chinese end-user guidance for install and workflow onboarding.Module playbook (ZH)Chinese module-by-module user handbook.Testing guideCurrent test commands, coverage boundaries, and Electron-vs-renderer notes.Channel integrationSupported platforms, webhook/stream modes, and runtime panels.Requirements baselineImplementation-aligned scope boundaries and current product expectations.

Quick picks​

  • Need the broad product overview? Start with README or FEATURES.md.
  • Need browsable site pages before jumping to GitHub source docs? Open User deep dives or Technical deep dives.
  • Need end-user setup and workflows? Open the User guide in your preferred language.
  • Need architecture or runtime details? Open the Technical docs.
  • Need document-intelligence planning notes? Open the LLM Wiki capability reference.
  • Need test, CI, or integration details? Use the Testing guide and Channel integration docs.

Coverage​

The repository documentation currently covers product usage, implementation details, testing, channel setup, and scope requirements. For packaged app downloads, use the separate Downloads page or GitHub Releases.

The current primary manuals are updated for the latest neutral-surface workbench refresh and the current accent palette set used by Settings.