[FEATURE]: ditch `/docs` path
Closed this issue · 10 comments
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
Hey! Can I add this on the website? Would love to contribute to SyntaxUI and get started with this
sure, all yours.
if you have any doubts then please ask me :)
We should implement this in a way that supports redirects from old urls to maintain backwards compatibility?
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
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
path is wrong, it should be for eg. components/loaders instead of components/components/loaders
@Ansub for this part:
instead of redirection to
https://syntaxui.com/docsit will behttps://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/
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
basically (docs) can what @vanshavenger suggested
then we can have redirections for components, effects, animations
eg. “syntaxui.com/components/button”,
Ya that's basically what I had implemented in the PR :)