Skip to content

docs: prepare public project documentation - #19

Merged
jmclong (jmclong) merged 1 commit into
mainfrom
dev/jlong/oss-public-readme
Aug 7, 2026
Merged

jmclong (jmclong) merged 1 commit into
mainfrom
dev/jlong/oss-public-readme

Conversation

@jmclong

Copy link
Copy Markdown
Contributor

Add an external landing page, architecture explanation, source-build guide, and AKS quickstart. Align production, client, controller, and stress-test documentation with the current implementation and public artifact model.

This pull request introduces extensive improvements to the DACS documentation, focusing on clarity, accuracy, and up-to-date guidance for users and contributors. Key additions include a new architecture overview, a streamlined AKS quickstart guide, and an updated build-from-source guide. Several existing docs are revised for correctness and better operational guidance, especially around cache scheduling and scaling.

Major documentation additions:

  • Added a comprehensive architecture overview to docs/architecture.md, detailing the control and data planes, system components, request flows, and important boundaries.
  • Introduced a new AKS quickstart guide in docs/quickstart.md, providing step-by-step instructions for deploying DACS, running smoke tests, and cleaning up resources.
  • Added a detailed build-from-source guide in docs/build-from-source.md, covering prerequisites, build steps, artifact locations, validation, devcontainer usage, and troubleshooting.

Improvements and corrections to existing documentation:

  • Updated the DACS Helm chart README to correct the cache enablement flag (cache.enabled), clarify persistent-storage scheduling (now integrated in the controller), and improve troubleshooting instructions. [1] [2]
  • Revised the scaling documentation for clarity: references to AKS are generalized to any node pool, and operational guidance points to the main user guide. [1] [2] [3] [4] [5]

@jmclong
jmclong (jmclong) marked this pull request as ready for review August 4, 2026 22:29
Add an external landing page, architecture explanation, source-build guide, and AKS quickstart. Align production, client, controller, and stress-test documentation with the current implementation and public artifact model.\n\nRelated work item: 38473441

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jmclong
jmclong (jmclong) force-pushed the dev/jlong/oss-public-readme branch from b6a452a to b3a41f6 Compare August 7, 2026 16:50
@jmclong
jmclong (jmclong) merged commit 2d4c7b6 into main Aug 7, 2026
36 checks passed
@jmclong
jmclong (jmclong) deleted the dev/jlong/oss-public-readme branch August 7, 2026 17:27
jmclong (jmclong) added a commit that referenced this pull request Aug 24, 2026
docs: prepare public project documentation
jmclong (jmclong) added a commit that referenced this pull request Aug 24, 2026
docs: prepare public project documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants