Skip to content

[FEATURE]: ditch /docs path #143

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

Closed
Ansub opened this issue May 4, 2024 · 10 comments · Fixed by #164
Closed

[FEATURE]: ditch /docs path #143

Ansub opened this issue May 4, 2024 · 10 comments · Fixed by #164
Assignees
Labels
enhancement New feature or request

Comments

@Ansub
Copy link
Member

Ansub commented May 4, 2024

Feature Description 📝

I am thinking of ditching /docs pathname, Get Started will get redirected to /components page which is basically /docs atm.

Motivation 🌟

Link sharing will become much easier. docs makes it appear overly complex, which seems unnecessary.

Expected Behavior 🤔

instead of redirection to https://syntaxui.com/docs it will be https://syntaxui.com/components

Additional Information ℹ️

No response

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request labels May 4, 2024
@PoulavBhowmick03
Copy link

Hey! Can I add this on the website? Would love to contribute to SyntaxUI and get started with this

@Ansub
Copy link
Member Author

Ansub commented May 5, 2024

sure, all yours.

if you have any doubts then please ask me :)

@Ansub Ansub removed the documentation Improvements or additions to documentation label May 5, 2024
@epoll31
Copy link
Contributor

epoll31 commented May 5, 2024

We should implement this in a way that supports redirects from old urls to maintain backwards compatibility?

@Ansub
Copy link
Member Author

Ansub commented May 5, 2024

yeah that should definitely be there, maybe you two can collaborate on this one. i think @epoll31 you can lead this one as this is a big change and you have more experience with the codebase of SyntaxUI

@PoulavBhowmick03
Copy link

SyntaxUI.-.Stop.coding.from.scratch.Build.faster.Launch.sooner.-.Brave.2024-05-06.11-33-38.mp4

Does this work? Or should there be more changes required

@Ansub
Copy link
Member Author

Ansub commented May 6, 2024

path is wrong, it should be for eg. components/loaders instead of components/components/loaders

@epoll31
Copy link
Contributor

epoll31 commented May 7, 2024

@Ansub for this part:

instead of redirection to https://syntaxui.com/docs it will be https://syntaxui.com/components

Do you want https://syntaxui.com/components to look like https://syntaxui.com/docs

In that case we would move the page.tsx from docs/ into components/

@epoll31 epoll31 mentioned this issue May 7, 2024
4 tasks
@vanshavenger
Copy link
Contributor

The Simple solution for the above can be making docs as (docs) and adding a page to all routes -> Components, animations, effects and hooks where we can say that a user can select a component from the sidebar to view it.

as otherwise if no pages.tsx made it will give a 404 error

@Ansub
Copy link
Member Author

Ansub commented May 7, 2024

basically (docs) can what @vanshavenger suggested

then we can have redirections for components, effects, animations

eg. “syntaxui.com/components/button”,

@epoll31
Copy link
Contributor

epoll31 commented May 7, 2024

Ya that's basically what I had implemented in the PR :)

@Ansub Ansub closed this as completed in #164 May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants