docs: add repo README and docs/ guides#5
Merged
Conversation
Add a repo-root README and a docs/ folder covering the library end to end: concepts, getting started, styled text, scrollback, the fixed region, dialogs, input & events, testing, architecture, and a full API reference. Update the NuGet-package README (src/Dcli/README.md): the Dcli.Testing harness now exists, and link out to the docs. All code samples were compiled against Dcli and Dcli.Testing to confirm they build against the real public API. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
Summary
Adds user-facing documentation for the library — there was none in-tree before (only
CLAUDE.md).README.md(new, repo root) — overview, install, quickstart, the mental model, a docs index, samples, and build instructions.docs/(new) — focused guides plus a full API reference:concepts.md— inline rendering, the commit horizon, the fixed region, the single-writer loop, mechanics-vs-semanticsgetting-started.md— install, first program, lifecycle, terminal requirementsstyled-text.md—Segment/Line/Style/Color/Format/LineBuilderscrollback.md—Append, live blocks, one-way collapsiblesfixed-region.md— input editor, status bar, autocompletedialogs.md—SelectAsync/MultiSelectAsync/ChoiceAsync/InputAsync, wizards,AllowBackevents.md— the event channel, key encoding caveats, Ctrl+C/signals, paste, resizetesting.md— fakingITerminal,HeadlessTerminal,VirtualClock, frame snapshotsarchitecture.md— the binding design decisions + the restore guarantee, distilled from the OpenSpec design docapi-reference.md— every public type with exact signaturessrc/Dcli/README.md(the NuGet package README) — corrected the stale "Dcli.Testing ships next release" note (it exists now) and added a docs link.Verification
DcliandDcli.Testingin a scratch project → builds clean. This caught a real trap: there is no string-items + string-title dialog-constructor overload, so those examples useLine.FromText(...)items.🤖 Generated with Claude Code