Skip to content

fix: use HTML comments for @generated markers in markdown, rename "Generated SDK"#746

Merged
pyramation merged 2 commits intomainfrom
devin/1772131612-cleanup-markdown-codegen
Feb 26, 2026
Merged

fix: use HTML comments for @generated markers in markdown, rename "Generated SDK"#746
pyramation merged 2 commits intomainfrom
devin/1772131612-cleanup-markdown-codegen

Conversation

@pyramation
Copy link
Copy Markdown
Contributor

@pyramation pyramation commented Feb 26, 2026

fix: use HTML comments for @generated markers in markdown output

Summary

The @constructive-io/graphql-codegen package was emitting > @generated by @constructive-io/graphql-codegen - DO NOT EDIT as 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.tsgetReadmeHeader() and buildSkillFile()
  • orm/docs-generator.tsgenerateOrmAgentsDocs()
  • hooks-docs-generator.tsgenerateHooksAgentsDocs()
  • cli/docs-generator.tsgenerateAgentsDocs() and generateMultiTargetAgentsDocs()
  • barrel.tsgenerateMainBarrel() and generateRootBarrel()
  • shared/index.tsgenerateSharedBarrel()

28 test snapshots updated to match.

Generated SDK output files also updated (245 files):

  • All .md files under sdk/constructive-sdk/ updated: > @generated …<!-- … -->
  • 4 root barrel index.ts files (src/auth/, src/admin/, src/public/, src/objects/) updated: Generated SDKGraphQL SDK
  • These were applied via direct string replacement (not a full codegen re-run, since the codegen script has unresolvable workspace dependency issues in this environment).

Review & Testing Checklist for Human

  • Spot-check a few generated markdown files (e.g. sdk/constructive-sdk/README.md, a couple skill .md files): confirm <!-- @constructive-io/graphql-codegen - DO NOT EDIT --> renders invisibly in GitHub markdown preview and the rest of the file content is untouched.
  • Verify AGENTS.md rendering: the > This document is structured for LLM/agent consumption. blockquote line that immediately follows the now-invisible HTML comment should still display correctly.
  • Consider running a full codegen re-run to confirm the sed-based output matches what the codegen would actually produce. The replacement was mechanical (> @generated…<!-- … --> and Generated SDKGraphQL SDK), but a codegen re-run would provide full confidence.

Notes

  • @generated annotations in .ts source file JSDoc comments were intentionally left unchanged (user confirmed these are fine in source code).
  • 5 pre-existing test suite failures (unrelated import resolution issues for pgsql-seed, gql-ast, etc.) — not introduced by this PR.
  • Requested by: @pyramation
  • Link to Devin run

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@pyramation pyramation merged commit 17df8ae into main Feb 26, 2026
44 checks passed
@pyramation pyramation deleted the devin/1772131612-cleanup-markdown-codegen branch February 26, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant