Skip to content

Docs: Add indexers API reference#23947

Merged
kylegach merged 10 commits into
nextfrom
indexer-api-ref
Sep 20, 2023
Merged

Docs: Add indexers API reference#23947
kylegach merged 10 commits into
nextfrom
indexer-api-ref

Conversation

@kylegach
Copy link
Copy Markdown
Contributor

@kylegach kylegach commented Aug 24, 2023

What I did

Checklist for Contributors

Testing

Manual testing

  1. Follow the steps in the contributing instructions for this branch, indexer-api-ref
  2. Review the new indexer page

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/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>

@kylegach kylegach self-assigned this Aug 24, 2023
Comment thread docs/configure/babel.md Outdated
@JReinhold
Copy link
Copy Markdown
Contributor

JReinhold commented Sep 8, 2023

@kylegach @jonniebigodes I've made some changes here to get it closer, but it's not quite ready yet:

  1. converted the title snippet to a proper snippet
  2. attempted to simplify the JSON stories example, and include an example JSON file as well as a psuedo Vite plugin
  3. Changed the combos example to instead refer to the Dynamic stories POC, as it's an actual implementation of something that shows off a similar concept, so I think it's a stronger starting point for people. If you disagree let me know. (we should update the code with the new API when it's been released though)
  4. added references to @storybook/addon-svelte-csf and storybook-vue-addon for the last example for custom language support. I think this is a very advanced use case that we can't document very well in our docs, so I hope referring to actual implementations is more valuable.

Let me know if you think we should do something else. @cdedreuille still has the ball on the diagram.

@JReinhold JReinhold added story index ci:docs Run the CI jobs for documentation checks only. labels Sep 8, 2023
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a 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.

Comment thread docs/api/main-config-indexers.md Outdated
Comment thread docs/api/main-config-indexers.md
Comment thread docs/api/main-config-indexers.md
Comment thread docs/api/main-config-indexers.md
Comment thread code/renderers/server/src/config.ts Outdated
@kylegach kylegach force-pushed the indexer-api-ref branch 2 times, most recently from aae6387 to cacec0d Compare September 14, 2023 22:00
Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor Author

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?

Copy link
Copy Markdown
Contributor

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.

@kylegach kylegach marked this pull request as ready for review September 14, 2023 22:03
@kylegach kylegach merged commit 1a0d84f into next Sep 20, 2023
@kylegach kylegach deleted the indexer-api-ref branch September 20, 2023 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation story index

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants