Repository navigation
docs: clarify authoring documentation boundary - #129
Merged
Merged
Conversation
albert20260301
approved these changes
Oct 30, 2026
albert20260301
left a comment
albert20260301
left a comment
There was a problem hiding this comment.
The contributor guidance now limits authoring documentation to decisions and code changes app authors actually need, while keeping automatic behavior in SDK components, types and regression tests. No blocking findings. Markdown lint, formatting and diff checks pass; required CI is green.
francoischalifour
approved these changes
Oct 30, 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.
Contributor guidance previously required guide and starter updates for public behavior changes, encouraging documentation of behavior already handled by the SDK. Clarify in AGENTS.md and CONTRIBUTING.md that authoring docs should cover decisions and actions required of app authors; automatic behavior and reusable patterns belong in components, defaults, types, and tests.
Validation: Markdown lint, formatting, and git diff checks pass. Link checking reports three existing broken links in packages/data-app/README.md; both changed files pass.