Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

indexer documentation is lacking #29515

Open
githorse opened this issue Nov 2, 2024 · 0 comments
Open

indexer documentation is lacking #29515

githorse opened this issue Nov 2, 2024 · 0 comments

Comments

@githorse
Copy link

githorse commented Nov 2, 2024

I'd like to call my storybook file Widget.demo.tsx instead of Widget.stories.tsx. This is possible with custom indexers; in fact, the docs specifically say

Unless your indexer is doing something relatively trivial (e.g. indexing stories with a different naming convention), in addition to indexing the file ...

But that link just takes me in circles -- nowhere does it tell me what that trivial indexer actually looks like. Digging into the API reference, the examples all seem to elide critical parts of the actual code:

// Read file and generate entries ... 

Could the docs be updated to show some real working examples of indexers, including a simple "noop" indexer that just picks up a different filename than the convention?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants