[WEB Improvement] : Make A Docs Part of create-my-api

[Puskar-Roy]

Quick Description 🛠️

Make A Docs Part For Create My API like other Docs Websites like vite

Select the open-source program you're contributing to

Other

Adherence to Code of Conduct

• [X] I adhere to the CONTRIBUTING GUIDELINES of this project.

[adityapandey23]

Hey @Puskar-Roy, I think I can implement this using Docusaurus. Will this work or you need some other implementation?

[Puskar-Roy]

@adityapandey23 absolutely I just need a well easy Documentation, like how users will use and contribute in create-my-api, like every cli has its own documentation like that.

[adityapandey23]

Okay assign me and I'll give my best shot!

[Puskar-Roy]

@adityapandey23 I think it would be better if you complete your assigned work first.

[adityapandey23]

@Puskar-Roy Is it okay if I finish this first and then the other work (you can unassign me from the other one!) ?

[Puskar-Roy]

@adityapandey23 sure

[adityapandey23]

Hey @Puskar-Roy I guess you forgot to assign me this issue

[Puskar-Roy]

@adityapandey23 my bad

[adityapandey23]

@Puskar-Roy I did change some folder structure in the project hope that's fine. Check the feat/documentation branch of my fork and lemme know if it's okay so that I can proceed to customize the UI.

I have encountered some further issues as well. Up until now it seems that we have been using tailwind as a local dependency (i.e. only in the main website folder). So now when we are adding another website, we have two options, either to push our dependencies like tailwind to the root level (removing it specifically from the main website dependency list) which will then make sure we can use it all across the projects or to ship each of these separately in each app.

Please tell me what would you prefer?

[Puskar-Roy]

@adityapandey23 See this is a Turbo Repo and Turbo repo is a monorepo so when you create a new folder in apps/ it means you add a new project in this repo so like

apps/
          --->web             // This is a Different Project 
          --->documentation  // And This is a Different Project 

so please dont do this like you do in your feat/documentation branch because all of my frontend present in apps/web

My recommendation is to check this docs of monorepo and turborepo for a Better understanding.

[Puskar-Roy]

@adityapandey23 what's the update..?

[Puskar-Roy]

@adityapandey23 hey like do you want to work with this issue?

[adityapandey23]

@Puskar-Roy Hey sorry I missed the previous notification :( Yes I do want to work on this but I am in between of my exams it's till Monday after that I can work on this. If this doesn't suits your schedule then you can un-assign me this...I'll contribute to some other issue once I am done with my exams! So sorry for missing the previous notification :(

[adityapandey23]

And yes I understood that you don't want it to be a different project and just want it to be a separate page in you current project. I mistook that you want to create a separate docs website like.

[AE-Hertz]

i guess you will be working on this, just please make sure to create a boilerplate first so other contributors like me can also help in building.

[Puskar-Roy]

@adityapandey23 ok that's fine, do u working on it?