Docs: Add indexers API reference#23947
Conversation
4eda630 to
5658cb0
Compare
|
@kylegach @jonniebigodes I've made some changes here to get it closer, but it's not quite ready yet:
Let me know if you think we should do something else. @cdedreuille still has the ball on the diagram. |
jonniebigodes
left a comment
There was a problem hiding this comment.
This is amazing, just some minor tweaks that need addressing. @kylegach let's sync up on this next week.
aae6387 to
cacec0d
Compare
There was a problem hiding this comment.
@JReinhold — Please confirm the accuracy of these diagrams, as well as the more detailed text representation appearing under them.
There was a problem hiding this comment.
Also, can https://github.com/storybookjs/storybook/blob/next/docs/configure/sidebar-and-urls.md?plain=1#L164-L203 be replaced with a brief paragraph explaining that a custom indexer should be used, and link to this reference?
There was a problem hiding this comment.
Looks good to me @kylegach ! and yes, I think it makes sense to change that too.
cacec0d to
db91927
Compare
- Add text representation of architectural diagram - Add/fix file name comments to snippets - Improve json stories snippets - Various tweaks to prose
db91927 to
3f60b60
Compare
What I did
Checklist for Contributors
Testing
Manual testing
indexer-api-reffrontpage:mainis up-to-date, to get the necessary style updatesDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>