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

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

Open
wants to merge 30 commits into
base: master
Choose a base branch
from

Conversation

sikehish
Copy link

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 sikehish marked this pull request as draft October 20, 2023 20:57
@sikehish sikehish marked this pull request as ready for review October 20, 2023 21:21
@vercel
Copy link

vercel bot commented Oct 21, 2023

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

Copy link
Member

@ad1992 ad1992 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  • [ ]
    image

  • Lets move this to docs folder

@sikehish
Copy link
Author

@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
Copy link
Author

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
Copy link
Author

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.

@ad1992 ad1992 changed the title Migrated the docs to Docusaurus(Issue #923) docs: Migrated the docs to Docusaurus(Issue #923) Oct 30, 2023
@ad1992
Copy link
Member

ad1992 commented Oct 31, 2023

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

@sikehish
Copy link
Author

sikehish commented Oct 31, 2023

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
Copy link
Author

@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.

@ad1992
Copy link
Member

ad1992 commented Oct 31, 2023

@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.

@sikehish
Copy link
Author

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

@sikehish
Copy link
Author

sikehish commented Oct 31, 2023

@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.

@ad1992
Copy link
Member

ad1992 commented May 6, 2024

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?

@sikehish
Copy link
Author

sikehish commented May 6, 2024

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?

@ad1992
Copy link
Member

ad1992 commented May 6, 2024

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
Copy link
Member

ad1992 commented May 16, 2024

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

@sikehish
Copy link
Author

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

@ad1992
Copy link
Member

ad1992 commented May 18, 2024

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.

@sikehish
Copy link
Author

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
Copy link
Author

sikehish commented May 25, 2024

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?

@ad1992
Copy link
Member

ad1992 commented May 27, 2024

@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
Copy link
Author

sikehish commented May 27, 2024

@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

@ad1992
Copy link
Member

ad1992 commented May 27, 2024

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

@sikehish
Copy link
Author

sikehish commented May 27, 2024

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

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

Successfully merging this pull request may close these issues.

None yet

2 participants