docs: Migrated the docs to Docusaurus(Issue #923)
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
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 |
@sikehish thank you for the PR ✨ let's do these first set of changes 👇
[ ]
[ ] Lets move this to docs folder
Sure! I will.
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 @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
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?
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
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 there is a nested docs directory created inside root leveldocs, can we club and merge these into the root level docs directory ?
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 there is a nested
docsdirectory created inside root leveldocs, can we club and merge these into the root leveldocsdirectory ?
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 there is a nested
docsdirectory created inside root leveldocs, can we club and merge these into the root leveldocsdirectory ?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.
Sure, I'll give that s shot and update very soon
@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.
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?
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?
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.
Hi @sikehish checking if you would be picking this up ?
Hi @ad1992 , I'd love to take this up. Can we decide on a deadline?
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.
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
Hi @ad1992 . Ive updated docusaurus. Let me know if any other changes are to be made.
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 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
@sikehish i think the changes from
readme.mdaren'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
I don't see the latest changes from readme in the docs
eg 👇🏻
I don't see the latest changes from readme in the docs eg 👇🏻
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
