Merged
Conversation
Restructure SDK documentation to follow the Diátaxis framework (Tutorial, How-to, Reference, Explanation) for both per-target READMEs and a new top-level README. New components: - ReadmeTop: generates cross-target top-level README.md - ReadmeHowto: target-specific how-to guides - ReadmeExplanation: target-specific conceptual docs Updated components: - Readme: reordered sections to follow Diátaxis - ReadmeIntro: target-aware intro text - ReadmeQuick: renamed to Tutorial format with step-by-step - ReadmeModel: delegates to target-specific reference summaries - ReadmeOptions: Go-aware syntax in code examples - ReadmeEntity: Go-aware operation signatures and examples - ReadmeRef: full Go syntax support (REFERENCE.md) Target-specific components added for both TS and Go: - ReadmeInstall, ReadmeQuick, ReadmeHowto, ReadmeModel - ReadmeExplanation (Go: maps, package structure) - ReadmeTopQuick, ReadmeTopTest, ReadmeTopHowto https://claude.ai/code/session_017UuVwiT77NneNu39kUTbnE
- Use entity.active instead of entity.publish for filtering (model does not define publish, only active) - Call names() on entities/features in ReadmeTop before accessing Name property, since ReadmeTop runs before Root.ts enrichment - Fix feature name display (feat.Name fallback to feat.name) - Verified: Go README uses Go syntax, TS README uses TS syntax, REFERENCE.md files are target-specific https://claude.ai/code/session_017UuVwiT77NneNu39kUTbnE
The install section shows a shell command (npm install), not TypeScript code. https://claude.ai/code/session_017UuVwiT77NneNu39kUTbnE
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
2 participants
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.
No description provided.