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

feat: added remix and tabbed installation docs #753

Merged
merged 13 commits into from
Jun 29, 2023
Merged

Conversation

csfh
Copy link
Contributor

@csfh csfh commented Jun 28, 2023

This PR adds installation documentation for Remix. Tested with the current version of Remix, Tailwind et cetera as of today.

Also adds nifty little tabs.

@changeset-bot
Copy link

changeset-bot bot commented Jun 28, 2023

⚠️ No Changeset found

Latest commit: c7aa3eb

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 Jun 28, 2023

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

Name Status Preview Comments Updated (UTC)
ui 🔄 Building (Inspect) Jun 28, 2023 3:13pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
next-template ⬜️ Ignored (Inspect) Jun 28, 2023 3:13pm

@vercel
Copy link

vercel bot commented Jun 28, 2023

@mdloop is attempting to deploy a commit to the shadcn-pro Team on Vercel.

A member of the Team first needs to authorize it.

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

Not sure what the procedure is in regards to changesets as it relates to the docs website. Let me know if I you want me to include something there as well.

@dan5py
Copy link
Contributor

dan5py commented Jun 28, 2023

Hi, I really thank you for your help! Actually I was thinking about having the docs page structured like this:

---
title: Installation
description: How to install dependencies and structure your app.
---

<Tabs defaultValue="nextjs">
  <TabsList>
    <TabsTrigger value="nextjs">
      Next.js
    </TabsTrigger>
    <TabsTrigger value="vite">
      Vite
    </TabsTrigger>
  </TabsList>

  <TabsContent value="nextjs">
      <FrameworkDocs data="nextjs" />
  </TabsContent>
  <TabsContent value="vite">
      <FrameworkDocs data="vite" />
  </TabsContent>
  <TabsContent value="remix">
      <FrameworkDocs data="remix" />
  </TabsContent>
  ...

With the folder frameworks inside content/docs where all the frameworks docs are stored. The FrameworkDocs component would then import the documentation based on the data passed as prop.
This results in a nice ui with tabs.

The Vite Docs page (with tabs) is already under development here #714.

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

Sounds good. Let me take a look and follow that. Is there any other branches I need to track into this one in order to do this?

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

On second look. This seems like sometimes we can do pretty quickly. Expect something today. With no other branches.

@dan5py
Copy link
Contributor

dan5py commented Jun 28, 2023

Is there any other branches I need to track into this one in order to do this?

Just #714 for now.

Expect something today.

Awesome!

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

@dan5py @samuelkurdz

I've added the tabs and included the vite documentation as well.

@csfh csfh changed the title feat: added remix installation docs feat: added remix/vite and tabbed installation docs Jun 28, 2023
Copy link
Contributor

@dan5py dan5py left a comment

Choose a reason for hiding this comment

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

Create the folder installation and move the content of the file installation.mdx to installation/index.mdx. Then put all the frameworks docs inside that folder (I think it's cleaner like this).

Please also remove the vite docs for now, I want that @samuelkurdz adds it when this gets merged (he deserves the credits).

apps/www/components/framework-docs.tsx Outdated Show resolved Hide resolved
apps/www/components/mdx-components.tsx Outdated Show resolved Hide resolved
apps/www/content/docs/installation.mdx Show resolved Hide resolved
apps/www/content/docs/installation.mdx Outdated Show resolved Hide resolved
@dan5py
Copy link
Contributor

dan5py commented Jun 28, 2023

BTW you are doing a really great job!

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

Please also remove the vite docs for now, I want that @samuelkurdz adds it when this gets merged (he deserves the credits).

100%!!!

@thesambayo
Copy link
Contributor

Please also remove the vite docs for now, I want that @samuelkurdz adds it when this gets merged (he deserves the credits).

100%!!!

Your update is actually wayyy cleaner!!
I will go through it to learn from it.

@csfh
Copy link
Contributor Author

csfh commented Jun 28, 2023

@dan5py @samuelkurdz

Should be good now. If this can be merged, then @samuelkurdz can update his PR to add vite.

@csfh csfh requested a review from dan5py June 28, 2023 15:14
Copy link
Contributor

@dan5py dan5py left a comment

Choose a reason for hiding this comment

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

@csfh csfh changed the title feat: added remix/vite and tabbed installation docs feat: added remix and tabbed installation docs Jun 28, 2023
Copy link
Collaborator

@shadcn shadcn left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

@shadcn shadcn merged commit eee7ce6 into shadcn-ui:main Jun 29, 2023
4 checks passed
suleymanbariseser pushed a commit to suleymanbariseser/shadcn-ui that referenced this pull request Jul 25, 2023
* docs: add react with vite installation guide

* refactor(docs): move Ract with vite page into installation.mdx as tab

* fix(docs): remove classnames and wrapper divs

* fix(docs): update tsconfig file path to default @

* feat: added remix installation docs

* feat: added tabbed installation docs

* fix: remove log statement

* fix: cleaned up, restored usage notice, removed vite for now

* fix: moved installation.mdx into folder

---------

Co-authored-by: Samuel Adebayo <samuel.adebayo@engagetech.com>
Co-authored-by: shadcn <m@shadcn.com>
kjxbyz pushed a commit to muse-ui/muse-ui that referenced this pull request Jun 7, 2024
* docs: add react with vite installation guide

* refactor(docs): move Ract with vite page into installation.mdx as tab

* fix(docs): remove classnames and wrapper divs

* fix(docs): update tsconfig file path to default @

* feat: added remix installation docs

* feat: added tabbed installation docs

* fix: remove log statement

* fix: cleaned up, restored usage notice, removed vite for now

* fix: moved installation.mdx into folder

---------

Co-authored-by: Samuel Adebayo <samuel.adebayo@engagetech.com>
Co-authored-by: shadcn <m@shadcn.com>
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

4 participants