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-beta] support path prefix for tutorial snippets #26792

Merged
merged 4 commits into from
Jan 3, 2025

Conversation

cmpadden
Copy link
Contributor

@cmpadden cmpadden commented Jan 2, 2025

Summary & Motivation

  • Adds support for pathPrefix in CodeExample component

This allows us to use examples that are outside of the docs_beta_snippets folder, for example, examples/tutorial_pinecone.

Tutorial was updated to demonstrate how this can be used:

<CodeExample
  pathPrefix="tutorial_pinecone/tutorial_pinecone"
  filePath="assets.py" 
  lineStart="22"
  lineEnd ="60"
  />

How I Tested These Changes

yarn dev

Changelog

NOCHANGELOG

@cmpadden cmpadden requested a review from neverett as a code owner January 2, 2025 20:11
@cmpadden cmpadden changed the base branch from dennis/doc-652-moce-pinecone-tutorial-to-beta-docs to master January 3, 2025 14:37
Copy link

github-actions bot commented Jan 3, 2025

Deploy preview for dagster-docs-beta ready!

Preview available at https://dagster-docs-beta-4y7n5jya7-elementl.vercel.app

Direct link to changed pages:

@cmpadden cmpadden merged commit e047b1e into master Jan 3, 2025
2 of 3 checks passed
@cmpadden cmpadden deleted the colton/code-example-path-prefix branch January 3, 2025 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants