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 get started index page #26401

Merged
merged 9 commits into from
Mar 13, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Mar 11, 2024

Note for reviewers:
There are currently issues displaying the images in the Gatsby site. While I work on those, the content can be reviewed, and you can see the intended design in the screenshot below.

What I did

Add a page at the docs/get-started/ route, which previously redirected to /docs/get-started/install. Frontpage will be updated to redirect /docs to this page instead of the install page.

Screenshot of full page

Checklist for Contributors

Testing

Manual testing

  1. Follow the steps in the contributing instructions for this branch, kylegach/sbdx-167-build-out-docs-homepage

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 Mar 11, 2024
Copy link

nx-cloud bot commented Mar 11, 2024

☁️ Nx Cloud Report

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

@kylegach kylegach 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 Mar 12, 2024
@kylegach kylegach marked this pull request as ready for review March 12, 2024 21:52
@JReinhold
Copy link
Contributor

Based on the screenshot it looks like the vertical spacing between these cards (between row 1 and row 2) is inconsistent with the spacing between all the other cards.

image

@cdedreuille
Copy link
Contributor

Thanks @kylegach and @JReinhold. This is now all fixed. Appart from the icons not showing up, this is how it look:

  • New design for frameworks
  • Responsive blocks to work on mobile & tablets
  • Improved spacing across the page
  • Moved the text (+remove the framework intro) below the list of frameworks. This is a proposition but it felt way cleaner to have the list of frameworks directly underneath the install block without any interruption. I think this is enough self explanatory to not have to intro the list.

Get started with Storybook _ Storybook docs

@cdedreuille cdedreuille self-requested a review March 13, 2024 12:20
Copy link
Contributor

@cdedreuille cdedreuille left a 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!

- Gatsby had trouble with its cache otherwise
@kylegach kylegach removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Mar 13, 2024
@kylegach kylegach merged commit fe254cf into next Mar 13, 2024
16 checks passed
@kylegach kylegach deleted the kylegach/sbdx-167-build-out-docs-homepage branch March 13, 2024 19:05
@github-actions github-actions bot mentioned this pull request Mar 13, 2024
18 tasks
kylegach added a commit that referenced this pull request Mar 13, 2024
- Same changes as in #26401, targeting `main`
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants