Repository navigation
chore(docs): add cli next mode docs - #1466
Merged
Merged
Conversation
Contributor
Greptile SummaryThe PR adds alpha documentation for Next mode and reorganizes ADRs to distinguish transition, Legacy, and imported Next decisions.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains. Important Files Changed
Reviews (2): Last reviewed commit: "chore: pr feedback" | Re-trigger Greptile |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds minimal but concrete documentation for the UDS CLI “Next mode” (alpha) so users and contributors can discover it, understand why it exists, and follow the new bundle workflow while Legacy remains the default.
Changes:
- Expand user-facing docs/landing pages to call out Legacy vs Next modes and link to Next mode reference docs.
- Add a dedicated “UDS CLI Next Mode” reference page covering capabilities, flags, and example workflows.
- Update contributor guidance and ADR organization to reflect the Legacy/Next transition and test tiers.
Reviewed changes
Copilot reviewed 35 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds CLI mode callout and a Next mode quickstart + mode-selection examples. |
| docs/reference/overview.mdx | Adds a reference-site entry card linking to the Next mode reference page. |
| docs/reference/next-mode.mdx | Introduces comprehensive Next mode reference documentation (concepts, capabilities, commands, flags, examples). |
| docs/index.mdx | Updates docs-site landing copy and adds a Next mode entry card. |
| docs/adr/next/0023-rooted-artifact-workspace-staging.md | New Next ADR documenting rooted workspace staging and security/operational tradeoffs. |
| docs/adr/next/0022-bundle-artifact-signing.md | New Next ADR documenting bundle signing approach and evidence storage. |
| docs/adr/next/0021-filesystem-trust-boundaries-for-commands.md | New Next ADR defining trusted vs untrusted filesystem boundaries and os.Root use. |
| docs/adr/next/0020-repository-package-structure.md | New Next ADR documenting repository structure and public/private Go package boundaries. |
| docs/adr/next/0019-separate-dev-deploy.md | New Next ADR defining separate dev deploy vs artifact deploy command surfaces. |
| docs/adr/next/0018-package-signature-verification.md | New Next ADR defining explicit per-package signature verification posture. |
| docs/adr/next/0017-hcl-file-function-scope.md | New Next ADR documenting file() evaluation/materialization behavior. |
| docs/adr/next/0016-uds-core-smoke-test-placement.md | New Next ADR defining UDS Core smoke test placement/tiering. |
| docs/adr/next/0015-multi-arch-bundle-distribution.md | New Next ADR describing multi-arch bundle distribution via root/child OCI indexes. |
| docs/adr/next/0014-integration-test-tiers.md | New Next ADR formalizing test tiers/tags/locations. |
| docs/adr/next/0013-deployer-package-hooks.md | New Next ADR documenting deploy hook extension points and concurrency considerations. |
| docs/adr/next/0012-library-logging-via-iostreams.md | New Next ADR documenting library logging via IOStreams. |
| docs/adr/next/0011-validation-at-public-library-entrypoints.md | New Next ADR documenting validation at public library boundaries. |
| docs/adr/next/0010-values-file-handling-for-bundle-deploy-from-artifact.md | New Next ADR documenting artifact values-file handling behavior and ordering. |
| docs/adr/next/0009-bundle-deploy-from-artifact.md | New Next ADR documenting artifact deploy flow, verification, and loader abstraction. |
| docs/adr/next/0008-bundle-reconfigure-operation.md | New Next ADR documenting reconfigure semantics and OCI-layer rewrite strategy. |
| docs/adr/next/0007-bundle-definition-and-value-files-in-oci-layout.md | New Next ADR documenting storing bundle definition/values as OCI artifact layers. |
| docs/adr/next/0006-opinionated-cli-settings.md | New Next ADR documenting configuration option set and defaults. |
| docs/adr/next/0005-interactivity.md | New Next ADR documenting non-interactive default and --prompt scope. |
| docs/adr/next/0004-logging-and-output-strategy.md | New Next ADR documenting stdout/stderr separation and result printing strategy. |
| docs/adr/next/0003-cli-command-structuring.md | New Next ADR documenting resource-first command structuring rationale. |
| docs/adr/next/0002-cli-architecture-patterns.md | New Next ADR documenting command options pattern, IOStreams, and testing approach. |
| docs/adr/next/0001-better-bundles-spec.md | New Next ADR documenting Better Bundles HCL spec and OCI layout concepts. |
| docs/adr/next/0000-record-architecture-decisions.md | New Next ADR establishing ADR usage for Next docs set. |
| docs/adr/legacy/0009-bundle-media-types.md | Fixes relative image link path to point at docs/.images. |
| docs/adr/legacy/0008-cli-output.md | Adds legacy ADR documenting stdout/stderr output expectations. |
| docs/adr/legacy/0007-caching.md | Adds legacy ADR documenting caching approach and tradeoffs. |
| docs/adr/legacy/0006-uds-engine-installation.md | Adds legacy ADR documenting UDS Engine installation decision. |
| docs/adr/legacy/0005-dev-mode.md | Adds legacy ADR documenting legacy dev mode decision. |
| docs/adr/legacy/0004-tui.md | Fixes relative image link path to point at docs/.images. |
| docs/adr/legacy/0003-bundle-create-arch.md | Fixes relative image link path to point at docs/.images. |
| docs/adr/legacy/0002-runner.md | Adds legacy ADR documenting UDS Runner decision and amendment. |
| docs/adr/legacy/0001-bundle-schema-tooling.md | Adds legacy ADR documenting initial bundle schema tooling decision. |
| docs/adr/0012-next-mode-transition.md | Adds transition ADR documenting Legacy/Next defaults and timeline. |
| docs/adr/0011-next-test-tiers.md | Adds transition ADR documenting Next test tiers/tasks/CI checks. |
| docs/adr/0010-legacy-next-coexistence.md | Updates transition ADR with clarified ADR locations and mode timeline notes. |
| CONTRIBUTING.md | Updates guidance for Legacy/Next coexistence, test tiering, and ADR locations. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 166e64c981
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Member
Author
|
@greptileai @codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0a218a023c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
slaskawi
reviewed
Aug 21, 2026
joelmccoy
force-pushed
the
add-next-docs
branch
from
August 21, 2026 14:00
ac3b216 to
f937f2e
Compare
joelmccoy
force-pushed
the
add-next-docs
branch
from
August 21, 2026 14:07
f937f2e to
91a19c7
Compare
joelmccoy
force-pushed
the
add-next-docs
branch
from
August 21, 2026 15:02
91a19c7 to
813fdde
Compare
bradclawsie
approved these changes
Aug 21, 2026
bradclawsie
left a comment
bradclawsie
left a comment
Contributor
There was a problem hiding this comment.
with caveats in discussion threads above, lgtm
chance-coleman
approved these changes
Aug 21, 2026
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.
Description
Updates documentation for next mode. There will be future documentation work to clean this up, but for now this is minimal amount of documentation we need to share.
docs/adr/legacy(and cleans up links)Related Issue
Relates to CLI-263
Type of change
Checklist before merging