Repository navigation
docs: formalize documentation and normative language rules - #5
Merged
Merged
Conversation
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Remove SPECIFICATIONS.md from being ignored Signed-off-by: Alex Godoy Wolff <13754094+alexgwolff@users.noreply.github.com>
Wrap requirement statements in text blocks and list the Intent link first, matching docs/README.md and the example spec. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Replace standalone SHALL/MAY/SHALL NOT labels with full EARS sentences whose subject is the software, move inline conditions into WHEN clauses, and nest Principles under the Intent section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Markdown is not rendered inside text code blocks, so the bold markers showed up as literal asterisks. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Signed-off-by: Alex Godoy Wolff <13754094+alexgwolff@users.noreply.github.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011uc2KL8jgKVwgzomc6Wdmp
Signed-off-by: Alex G. Wolff <13754094+alexgwolff@users.noreply.github.com>
Signed-off-by: Alex Godoy Wolff <13754094+alexgwolff@users.noreply.github.com>
alexgwolff
marked this pull request as draft
September 29, 2026 17:16
alexgwolff
marked this pull request as ready for review
September 30, 2026 04:30
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.
Summary
Establishes a consistent documentation workflow for Kraf's contributors and agents, with explicit normative language, traceable specifications, and navigation through documentation links. Repository-wide documentation is organized under
docs/, while the root keeps the repository README and agent entry point.What does this pull request change?
docs/ARCHITECTURE.mdfor Kraf's target architecture, consolidates repository conventions indocs/BUILDING.md, and separates code invariants intodocs/CODE_STANDARDS.md.docs/README.mdas the documentation index and updates links and the allowlist for the new structure.docs/SPEC_CONVENTIONS.md, aligns intent filename conventions, and defines ADR structure, statuses, and supersession links while preserving accepted decision content.docs-reviewskill with adocsskill for creation, editing, and review, including scoped inventories, document reachability, and link/anchor checks.AGENTS.mdthe documentation entry point and requires agents to follow relevant links; searches remain available for inventory and validation.MacOSspelling in the environment-variable host acceptance document.How to test?
docs/BUILDING.mdanddocs/SPEC_CONVENTIONS.md, using thedocsskill.AGENTS.mdthroughdocs/README.md; verify document reachability, relative-link targets, and identifier anchors.Links.Other Notes and Links
docs/ARCHITECTURE.mddescribes the target architecture, including planned capabilities.