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

docs: Add example to the Indexer API doc #29272

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

Sidnioulz
Copy link
Contributor

@Sidnioulz Sidnioulz commented Oct 3, 2024

What I did

Added a doc example on the Indexer API, pointing to a Stackblitz that shows how to hack the Indexer API and a few other parts of SB to add external URLs to the sidebar.

This is useful because it shows how to connect arbitrary formats in the Indexer and in a Vite plugin that outputs CSF on each named export being indexed.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

not relevant

Manual testing

Caution

Please note I couldn't live test the change. I couldn't manage to run frontpage and will require help to run it.

Documentation

  • Add or update documentation reflecting your changes

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>

Greptile Summary

This PR enhances the Indexer API documentation by adding a new advanced example demonstrating how to create sidebar links from a collection of URLs.

  • Added a detailed example in docs/api/main-config/main-config-indexers.mdx showcasing URL-based sidebar links
  • Demonstrates integration of custom indexer, Vite plugin, and manager customization
  • Includes a link to a StackBlitz demo for a complete working example
  • Illustrates the flexibility of the Indexer API for processing non-standard story formats

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Oct 3, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 6b90a2a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman added documentation story index ci:docs Run the CI jobs for documentation checks only. labels Oct 7, 2024
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