ai-workspace-services/portal
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
85df4e9c85
portal/docs
History
Haitao Pan 01c879c143 feat(auth): support shared session tokens and device/node pairing integration
2026-01-30 23:18:37 +08:00
..
advanced docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
api docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
appendix docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
architecture docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
development docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
getting-started docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
governance docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
integrations feat(auth): support shared session tokens and device/node pairing integration 2026-01-30 23:18:37 +08:00
operations docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
usage docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
README.md docs: reorganize documentation structure 2026-01-26 21:39:00 +08:00
SEO-AUDIT-REPORT.md feat: add comprehensive SEO metadata, structured data, a custom 404 page, and SEO audit tooling. 2026-01-29 12:57:22 +08:00
SEO-WORK-SUMMARY.md docs: add SEO work summary 2026-01-29 13:43:08 +08:00

README.md

Documentation

This directory follows a standard open-source documentation layout and mirrors the code organization of console.svc.plus.

Structure

  • getting-started/ — new user path to get running quickly.
  • architecture/ — system design, boundaries, and decisions.
  • usage/ — configuration and how-to guides.
  • api/ — service API references.
  • integrations/ — external systems and providers.
  • advanced/ — performance, security, scalability, customization.
  • development/ — contributor guides and local setup.
  • operations/ — logging, monitoring, troubleshooting, runbooks.
  • governance/ — license, security policy, release process.
  • appendix/ — FAQ, glossary, references.

Codebase Mapping

  • App layer (Next.js): src/app, src/components, src/lib, src/state, src/modules
  • Library layer (vendored): packages/neurapress
  • Build/runtime glue: scripts, config, public

Index

  • Getting Started
    • getting-started/introduction.md
    • getting-started/quickstart.md
    • getting-started/installation.md
    • getting-started/concepts.md
  • Architecture
    • architecture/overview.md
    • architecture/components.md
    • architecture/design-decisions.md
    • architecture/roadmap.md
  • Usage
    • usage/cli.md
    • usage/config.md
    • usage/deployment.md
    • usage/examples.md
  • API
    • api/overview.md
    • api/auth.md
    • api/endpoints.md
    • api/errors.md
  • Integrations
    • integrations/databases.md
    • integrations/cloud.md
    • integrations/ai-providers.md
  • Advanced
    • advanced/performance.md
    • advanced/security.md
    • advanced/scalability.md
    • advanced/customization.md
  • Development
    • development/contributing.md
    • development/dev-setup.md
    • development/testing.md
    • development/code-structure.md
  • Operations
    • operations/logging.md
    • operations/monitoring.md
    • operations/backup.md
    • operations/troubleshooting.md
    • operations/runbooks/README.md
    • operations/runbooks/rag-server.md
  • Governance
    • governance/license.md
    • governance/security-policy.md
    • governance/release-process.md
  • Appendix
    • appendix/faq.md
    • appendix/glossary.md
    • appendix/references.md