fix: use HTML comments for @generated markers in markdown, rename "Generated SDK"#746
Merged
pyramation merged 2 commits intomainfrom Feb 26, 2026
Merged
Conversation
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
fix: use HTML comments for @generated markers in markdown output
Summary
The
@constructive-io/graphql-codegenpackage was emitting> @generated by @constructive-io/graphql-codegen - DO NOT EDITas a blockquote in generated markdown files (READMEs, AGENTS.md, skill files). This renders visibly and looks out of place. This PR changes all markdown generators to emit an HTML comment (<!-- ... -->) instead, which is invisible in rendered markdown while still serving as a machine-readable marker.Additionally, renames "Generated SDK" / "Auto-generated GraphQL SDK" to just "GraphQL SDK" in JSDoc headers of barrel files, since the "generated" branding in the name is unnecessary.
Codegen source files changed (6):
docs-utils.ts—getReadmeHeader()andbuildSkillFile()orm/docs-generator.ts—generateOrmAgentsDocs()hooks-docs-generator.ts—generateHooksAgentsDocs()cli/docs-generator.ts—generateAgentsDocs()andgenerateMultiTargetAgentsDocs()barrel.ts—generateMainBarrel()andgenerateRootBarrel()shared/index.ts—generateSharedBarrel()28 test snapshots updated to match.
Generated SDK output files also updated (245 files):
.mdfiles undersdk/constructive-sdk/updated:> @generated …→<!-- … -->index.tsfiles (src/auth/,src/admin/,src/public/,src/objects/) updated:Generated SDK→GraphQL SDKReview & Testing Checklist for Human
sdk/constructive-sdk/README.md, a couple skill.mdfiles): confirm<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->renders invisibly in GitHub markdown preview and the rest of the file content is untouched.> This document is structured for LLM/agent consumption.blockquote line that immediately follows the now-invisible HTML comment should still display correctly.> @generated…→<!-- … -->andGenerated SDK→GraphQL SDK), but a codegen re-run would provide full confidence.Notes
@generatedannotations in.tssource file JSDoc comments were intentionally left unchanged (user confirmed these are fine in source code).pgsql-seed,gql-ast, etc.) — not introduced by this PR.