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

Adding complete documentation in the main repository and redesigning it. #374

Open
Gitstar-OC opened this issue Nov 17, 2024 · 3 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@Gitstar-OC
Copy link

Description

Currently we have different repositories for docs and the website which is not what should happen or the contributors might be overhelmed by cloning so many things in the future to update normal things. I am suggesting that (will do the complete thing by myself and pull a request) we should add the documentation in this single repo for the sole purpose of making things simple and save time in the longer term instead of maintaining multiple repositories.

I have also wrote a lot of technical documentation and have well structured it at my own documentation sites.
Here's a link => https://mindect.vercel.app/learn (you can select a topic and see the documentation for it. In addition to that I can also improve it a lot.

Additional Information

I will be using Fumadocs plugin or packages for this which are fully customizable, open source and free of cost!

@Gitstar-OC Gitstar-OC changed the title Adding complete documentation in the main repoand redesigning it. Adding complete documentation in the main repository and redesigning it. Nov 17, 2024
@Dmedina20
Copy link

@Fryingpannn is this something we are looking at doing

@Fryingpannn
Copy link
Contributor

Fryingpannn commented Nov 17, 2024

Hmmm possibly! Thank you for the input. Let's put this on hold for just now. Currently our priorities are a bit locked so will be hard to review this. I shall get back to this later.

However, if you think you can do this in a clean way that is easy to review. I am open to it. But I cannot guarantee we'll merge the final result as I'm not sure what the changes will look like yet!

@Dmedina20 Dmedina20 added the documentation Improvements or additions to documentation label Nov 18, 2024
@Gitstar-OC
Copy link
Author

I could share up some other links to show how this might look along with the images of how they look now, this can be completely modified.

https://turbo.build/pack/docs
image

https://nuqs.47ng.com/docs/installation
image

https://supastarter.dev/docs/nextjs
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants