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: Maintenance - Fix snippets and documentation #29683

Merged
merged 9 commits into from
Nov 22, 2024

Conversation

jonniebigodes
Copy link
Contributor

@jonniebigodes jonniebigodes commented Nov 21, 2024

This pull request follows up on #28391 and applies the same functionality to the current version of the documentation.

What was done:

  • Fixed snippets including some of those that were no longer being displayed with the recent documentation migration
  • Vetted the documentation and adjusted it to remove unnecessary items from the code snippets
  • Other misc changes

Greptile Summary

Based on the provided information, I'll create a concise summary of the documentation changes in this pull request.

Documentation cleanup and formatting improvements across Storybook's documentation files, focusing on standardizing code snippets and improving readability.

  • Removed unnecessary file name comments in favor of code block title attributes for better readability
  • Removed redundant CSF2/CSF3 path parameters from CodeSnippets components as part of standardization
  • Added proper framework configuration examples for Vue and Web Components with both JavaScript and TypeScript support
  • Fixed inconsistent string literal syntax in framework documentation (changing {'react'} to "react")
  • Improved organization of telemetry and crash reporting documentation with clearer configuration options

The changes are primarily focused on documentation maintenance and clarity, with no functional changes to the codebase.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Nov 21, 2024
@jonniebigodes jonniebigodes self-assigned this Nov 21, 2024
@jonniebigodes jonniebigodes changed the title Docs fix snippets v3 Docs: Maintenance - Fix snippets and documentation Nov 21, 2024
Copy link

nx-cloud bot commented Nov 21, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 726dd05. 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.

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.

293 file(s) reviewed, 25 comment(s)
Edit PR Review Bot Settings | Greptile

docs/_snippets/chromatic-github-action.md Show resolved Hide resolved
docs/_snippets/csf-2-example-story.md Outdated Show resolved Hide resolved
docs/_snippets/csf-2-example-story.md Outdated Show resolved Hide resolved
docs/_snippets/csf-3-example-render.md Outdated Show resolved Hide resolved
docs/_snippets/csf-3-example-starter.md Outdated Show resolved Hide resolved
docs/get-started/install.mdx Show resolved Hide resolved
docs/sharing/package-composition.mdx Outdated Show resolved Hide resolved
@jonniebigodes
Copy link
Contributor Author

Going to self-merge this to get the snippets fixed

@jonniebigodes jonniebigodes merged commit 896be2b into next Nov 22, 2024
9 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_snippets_v3 branch November 22, 2024 21:46
yannbf pushed a commit that referenced this pull request Nov 29, 2024
Docs: Maintenance - Fix snippets and documentation
(cherry picked from commit 896be2b)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Nov 29, 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 patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant