-
-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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-ref
frontpage:main
is 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:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make 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/core
team 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>