Skip to content

Conversation

@ieedan
Copy link
Collaborator

@ieedan ieedan commented Jun 11, 2025

Alternative to #538

Fixes #537

This PR enables registry owners to include documentation files (*.md, *.mdx) in their registry. This can help users (or llms) with the usage of registry items. Just like tests adding documentations files is opt-in with the includeDocs config key.

@Asuniia thank you for your initial work on this I have added you as a co-author on this PR. Also apologies for how long this took!

Co-authored-by: Théo LAGACHE <theo@lagache.dev>
@ieedan ieedan self-assigned this Jun 11, 2025
@changeset-bot
Copy link

changeset-bot bot commented Jun 11, 2025

🦋 Changeset detected

Latest commit: 1d342bb

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

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

@pkg-pr-new
Copy link

pkg-pr-new bot commented Jun 11, 2025

Open in StackBlitz

pnpm dlx https://pkg.pr.new/jsrepojs/jsrepo@577

commit: 1d342bb

@ieedan ieedan merged commit d13b121 into main Jun 11, 2025
3 checks passed
@ieedan ieedan deleted the include-docs-in-registry branch June 11, 2025 19:30
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.

feat: Allow doc files (.md, .md) to be included with registry

2 participants