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

V2 Theme generator and doc updates #1816

Merged
merged 13 commits into from
Aug 4, 2023
Merged

Conversation

endigo9740
Copy link
Contributor

@endigo9740 endigo9740 commented Aug 2, 2023

Linked Issue

Closes #1781

Description

  • Updates the getting started instruction @ /docs/get-started (manual tab)
  • Updates the Themes documentation @ /docs/themes
  • Updates the theme generator install documentation @ /docs/generator
  • Updates the theme generator to output the v2 CSS-in-JS format

Changsets

Instructions: Changesets automate our changelog. If you modify files in /packages/skeleton, run pnpm changeset in the root of the monorepo, follow the prompts, then commit the markdown file. Changes that add features should be minor while chores and bugfixes should be patch. Please prefix the changeset message with feat:, bugfix: or chore:.

Checklist

Please read and apply all contribution requirements.

  • This PR targets the dev branch (NEVER master)
  • Documentation reflects all relevant changes
  • Branch is prefixed with: docs/, feat/, chore/, bugfix/
  • Ensure Svelte and Typescript linting is current - run pnpm check
  • Ensure Prettier linting is current - run pnpm format
  • All test cases are passing - run pnpm test
  • Includes a changeset (if relevant; see above)

@changeset-bot
Copy link

changeset-bot bot commented Aug 2, 2023

⚠️ No Changeset found

Latest commit: c489c61

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Aug 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
skeleton-docs ✅ Ready (Inspect) Visit Preview Aug 3, 2023 5:13pm

@endigo9740 endigo9740 changed the title Theme generator updated to v2 CSS in JS format V2 Theme generator and doc updates Aug 2, 2023
@endigo9740
Copy link
Contributor Author

@AdrianGonz97 I'm adding you as a reviewer to ensure all technical details are correct.

@niktek I'm adding you to verify the CLI follows this instruction

@Sarenor I'm going to ping you as well to review the general flow of the information and to help proofread.

I've rewritten large portions of the pages so it can't hurt for everyone to proof this.

@endigo9740 endigo9740 marked this pull request as ready for review August 2, 2023 20:55
@endigo9740
Copy link
Contributor Author

endigo9740 commented Aug 3, 2023

@AdrianGonz97 I did one more pass through to improve some of the text. I also implemented a section on the Theme Generator page noting the v1 to v2 migration process. I plan to write up a proper migration guide on GitHub in around launch, so we can include both the guide and tool link straight from that page soon.

Unless you see anything else I think we're ready to merge this.

@endigo9740 endigo9740 merged commit 32583dc into v2 Aug 4, 2023
3 checks passed
@endigo9740 endigo9740 deleted the feat/v2-theme-generator-doc-updates branch August 4, 2023 16:33
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.

None yet

3 participants