react-tags icon indicating copy to clipboard operation
react-tags copied to clipboard

docs: Migrated the docs to Docusaurus(Issue #923)

Open sikehish opened this issue 2 years ago • 25 comments

I've migrated it to Docusaurus(v2). I've also added a custom favicon, and also made it readable. It can be found in the react-tags-docusaurus directory.

cd react-tags-docusaurus
npm i
npm start

sikehish avatar Oct 20 '23 20:10 sikehish

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

Name Status Preview Comments Updated (UTC)
react-tags ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2024 11:15am

vercel[bot] avatar Oct 21 '23 09:10 vercel[bot]

@sikehish thank you for the PR ✨ let's do these first set of changes 👇

  • [ ] image

  • [ ] Lets move this to docs folder

Sure! I will.

sikehish avatar Oct 27 '23 15:10 sikehish

Hi @ad1992. I didnt understand the options part. Do you want a single options file instead of a directory? Also,I didnt understand the "Move this to under react tags" comment . What should be moved?

sikehish avatar Oct 27 '23 16:10 sikehish

Hi @ad1992. I didnt understand the options part. Do you want a single options file instead of a directory? Also,I didnt understand the "Move this to under react tags" comment . What should be moved?

HI @sikehish, yes let's make options a single file instead of a directory. And by "React Tags"I mean the file "React Tags"so all the categories - from "Support" to "Thanks" can be clubbed inside the React Tags file.

Let me know if everything is clear and if you have any questions

ad1992 avatar Oct 28 '23 19:10 ad1992

Thanks for the clarification! Also, about migrating docusaurus directory to docs dir, do I eliminate the package.json file that is present in the docusaurus dir and add a command for it in the main package.json file or copy it with the package.json file? Any special instructions with tegards to that?

sikehish avatar Oct 28 '23 19:10 sikehish

Thanks for the clarification! Also, about migrating docusaurus directory to docs dir, do I eliminate the package.json file that is present in the docusaurus dir and add a command for it in the main package.json file or copy it with the package.json file? Any special instructions with tegards to that?

separate package.json for docs directory is absolutely fine and preferrable as well

ad1992 avatar Oct 28 '23 19:10 ad1992

Thanks for the clarification! Also, about migrating docusaurus directory to docs dir, do I eliminate the package.json file that is present in the docusaurus dir and add a command for it in the main package.json file or copy it with the package.json file? Any special instructions with tegards to that?

separate package.json for docs directory is absolutely fine and preferrable as well

Hi @ad1992, Ive made all the changes that you had specified. You can try it out and let me know if any changes are to be made.

sikehish avatar Oct 29 '23 07:10 sikehish

@sikehish there is a nested docs directory created inside root leveldocs, can we club and merge these into the root level docs directory ?

ad1992 avatar Oct 31 '23 04:10 ad1992

Hi @ad1992 I'm not sure if that can be done, cuz the nested docs dir is configured to serve the .md files. I can club and merge it into the roots dir, but then that might make it more unstructured, as we have src directory, static directory and a host of other files and images in the root level docs directory

sikehish avatar Oct 31 '23 04:10 sikehish

@sikehish there is a nested docs directory created inside root leveldocs, can we club and merge these into the root level docs directory ?

I can rename the directory to something more meaningful if need be, or if you think that clubbing and merging at the root level docs directory is required, then I'll get started with it.

sikehish avatar Oct 31 '23 04:10 sikehish

@sikehish there is a nested docs directory created inside root leveldocs, can we club and merge these into the root level docs directory ?

I can rename the directory to something more meaningful if need be, or if you think that clubbing and merging at the root level docs directory is required, then I'll get started with it.

@sikehish Its best we merge both the docs into the single root level docs directly so let's do that.

ad1992 avatar Oct 31 '23 06:10 ad1992

Sure, I'll give that s shot and update very soon

sikehish avatar Oct 31 '23 12:10 sikehish

@ad1992 I've spent quite some time trying to have all the docs(.md files) under the root docs directory, and Ive tried toying with all the configs possible, but that isnt possible. I checked the docs, and as per the docs, we need to have the docs directory. I felt like I pulled it off but I realized that the built in configs expect the devs to include docs dir.

sikehish avatar Oct 31 '23 14:10 sikehish

Hi @sikehish apologies for not getting back on this PR. There have been changes in docs recently, do you want to update this PR with latest changes and then we can merge it sooner this week?

ad1992 avatar May 06 '24 13:05 ad1992

Hi. Sure, I'd love to do that. Do I contine with the same approach? Or anything that you'd want me to keep in mind?

sikehish avatar May 06 '24 14:05 sikehish

Hi. Sure, I'd love to do that. Do I contine with the same approach? Or anything that you'd want me to keep in mind?

Both the docs would ideally be merged into one, but as you mentioned that looks tricky now so in that case let's rename the docusaurus docs folder to dev-docs and move to root folder.

ad1992 avatar May 06 '24 15:05 ad1992

Hi @sikehish checking if you would be picking this up ?

ad1992 avatar May 16 '24 07:05 ad1992

Hi @ad1992 , I'd love to take this up. Can we decide on a deadline?

sikehish avatar May 18 '24 12:05 sikehish

Hi @ad1992 , I'd love to take this up. Can we decide on a deadline?

The sooner the better :) Would be great if you could push the changes in the coming week.

ad1992 avatar May 18 '24 14:05 ad1992

Hi @ad1992 , I'd love to take this up. Can we decide on a deadline?

The sooner the better :) Would be great if you could push the changes in the coming week.

Sorry for the delay :( Im getting started with it right now

sikehish avatar May 25 '24 06:05 sikehish

Hi @ad1992 . Ive updated docusaurus. Let me know if any other changes are to be made. image Do you want the docs folder to be renamed to dev-docs or the docs subdir under this docs folder to be renamed to dev-docs?

sikehish avatar May 25 '24 12:05 sikehish

@sikehish i think the changes from readme.md aren't pulled in this branch? As per the rename let it be as it is, I will try to merge both into single docs folder

ad1992 avatar May 27 '24 10:05 ad1992

@sikehish i think the changes from readme.md aren't pulled in this branch? As per the rename let it be as it is, I will try to merge both into single docs folder

Apologize for the inconvenience. Ive pushed the changes

sikehish avatar May 27 '24 11:05 sikehish

I don't see the latest changes from readme in the docs eg 👇🏻 Screenshot 2024-05-27 at 4 37 39 PM

ad1992 avatar May 27 '24 11:05 ad1992

I don't see the latest changes from readme in the docs eg 👇🏻 Screenshot 2024-05-27 at 4 37 39 PM

Oops! Apologize for the oversight. Ive fixed it. Hope everything's in place now. Let me know if any other changes are to be made

sikehish avatar May 27 '24 11:05 sikehish