Repository navigation
Update the README and docs for 1.0 - #108
Merged
Merged
Conversation
Add docs/faq.md with the questions teams ask before adopting DLD (cost, what runs in the repository, CI, stopping), and a quickstart path that records a decision for existing code and shows the rule at work. Mark the concept papers as the original early thinking, kept as written, and the first skill design plan as historical; link the skill sources and dld-kit's own decision log instead. Explain the files in the decisions folder, including .dld-state.yaml, and replace the old workflow images and init steps in workflows.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
Contributor
Unit test coverage
Changes are relative to Per file
|
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
…fy combining DLD with a spec tool Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
…unning solo projects Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG
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.
Docs only (empty changeset). This addresses a stale-docs sweep and feedback from a review written as a first-time user.
New
docs/faq.md: a current FAQ covering ADRs vs DLD, using it alongside spec-driven tools, cost, whatinitadds and what to commit (including.dld-state.yaml), what the bundled CLI runs, languages, whether the agent obeys the rule, CI without an LLM, ID clashes, annotation density, how to stop using DLD, and small projects./dld-decidefor existing code, then/dld-implement DL-001, then a change against the decision to watch the rule fire./dld-planflow is now under "Build a feature".init.Early thinking, kept as written
docs/plan/skill-design.mdis marked historical, since it describes the 0.x bash and SNAPSHOT.md skills. The README links totemplates/skills/and dld-kit's own decision log instead.Fixes
docs/workflows.md:user-attachmentsimages are replaced by the README's local SVG diagram.npx dld-kit init(or the dld-init skill) instead of/dld-initin the command blocks.docs/framework/decision-record-format.md: explains INDEX.md, OVERVIEW.md, PRACTICES.md and.dld-state.yaml.docs/framework/project-configuration.md: the made-up model namegpt-sol-6.1becomessonnet.releasing.md.CLAUDE.md: the directory tree is updated.Not here: the RC banner,
releasing.md's "Release candidates" section anddocs/plan/v1.md's status. They change in the pre-exit PR, because they're correct until then.Checks:
npm test(551 + 17 pass), lint,check:generatedand relative link checks pass. Docs are excluded from annotation scanning, so the README's@decision(DL-001)example doesn't count as an annotation.🤖 Generated with Claude Code
https://claude.ai/code/session_01GmUuswDi3BJNN76DyoJHCG