Repository navigation
docs: prepare public project documentation - #19
Merged
Merged
Conversation
jmclong (jmclong)
marked this pull request as ready for review
August 4, 2026 22:29
jmclong (jmclong)
requested a review
from Simon Croome (croomes)
as a code owner
August 4, 2026 22:29
Simon Croome (croomes)
approved these changes
Aug 6, 2026
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)
force-pushed
the
dev/jlong/oss-public-readme
branch
from
August 7, 2026 16:50
b6a452a to
b3a41f6
Compare
Simon Croome (croomes)
approved these changes
Aug 7, 2026
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
docs/architecture.md, detailing the control and data planes, system components, request flows, and important boundaries.docs/quickstart.md, providing step-by-step instructions for deploying DACS, running smoke tests, and cleaning up resources.docs/build-from-source.md, covering prerequisites, build steps, artifact locations, validation, devcontainer usage, and troubleshooting.Improvements and corrections to existing documentation:
cache.enabled), clarify persistent-storage scheduling (now integrated in the controller), and improve troubleshooting instructions. [1] [2]