Skip to content

Comments

feat(core): support resource-scoped custom docs grouped by type#2159

Draft
thorthelegend99 wants to merge 11 commits intoevent-catalog:mainfrom
thorthelegend99:feat/resource-custom-docs-v1
Draft

feat(core): support resource-scoped custom docs grouped by type#2159
thorthelegend99 wants to merge 11 commits intoevent-catalog:mainfrom
thorthelegend99:feat/resource-custom-docs-v1

Conversation

@thorthelegend99
Copy link
Contributor

Summary

Adds v1 support for resource-scoped custom docs under resource folders (e.g. domains/<id>/docs/**) with sidebar grouping by type.

What shipped

  • New resourceDocs Astro content collection
    • Scans docs under resource folders for:
      • domains, services, events, commands, queries, flows, channels, entities, containers, data-products
    • Requires frontmatter: id, version, type
  • New utility layer: resource-docs.ts
    • Resolves resource ownership by file path
    • Builds grouped docs by type
    • Uses first-match behavior for duplicate collisions
  • New resource docs route:
    • /docs/:type/:id/:version/docs/:docType/:docId/:docVersion
  • Sidebar integration
    • Adds grouped custom-doc sections (group title = type) on resource pages in left nav
  • Included changeset for @eventcatalog/core

Notes

  • No search indexing yet (intentional)
  • No generator/SDK support yet (intentional)

Validation

  • pnpm --filter @eventcatalog/core format
  • pnpm --filter @eventcatalog/core check (0 errors)

@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2026

🦋 Changeset detected

Latest commit: 3269ae6

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@eventcatalog/core Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@CLAassistant
Copy link

CLAassistant commented Feb 16, 2026

CLA assistant check
All committers have signed the CLA.

@boyney123
Copy link
Collaborator

Be good to add support for our [[]] syntax in the docs to highlight docs etc.

@thorthelegend99 thorthelegend99 force-pushed the feat/resource-custom-docs-v1 branch from 6cb5c79 to 3269ae6 Compare February 17, 2026 22:21
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.

3 participants