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

Migrate the docs to Docusaurus #923

Open
ad1992 opened this issue Oct 18, 2023 · 7 comments
Open

Migrate the docs to Docusaurus #923

ad1992 opened this issue Oct 18, 2023 · 7 comments

Comments

@ad1992
Copy link
Member

ad1992 commented Oct 18, 2023

For better readability lets move the docs to Docusaurus

@adarsht0001
Copy link

can u explain the issue a bit more @ad1992

@ad1992
Copy link
Member Author

ad1992 commented Oct 18, 2023

@adarsht0001 you can check the existing docs in README.md, for better readabilty of documentation lets migrate it to Docusaurus

@ad1992 ad1992 changed the title Move the docs to Docusaurus Migrate the docs to Docusaurus Oct 18, 2023
@sikehish
Copy link

sikehish commented Oct 20, 2023

Hi @ad1992 . Can you assign this issue to me, if unassigned? Im working on it.
Also, do you want to migrate the entire README.md to Docusaurus ?

@ad1992
Copy link
Member Author

ad1992 commented Oct 20, 2023

sure go ahead @sikehish!
Yes the entire README.md should be migrated

@sikehish
Copy link

sikehish commented Oct 20, 2023

sure go ahead @sikehish! Yes the entire README.md should be migrated

Thank you! Im working on it.
Should I use Docusaurus v1 or v2?
(Just wanted to clarify:) )

@ad1992
Copy link
Member Author

ad1992 commented Oct 20, 2023

sure go ahead @sikehish! Yes the entire README.md should be migrated

Thank you! Im working on it. Should I use Docusaurus v1 or v2? (Just wanted to clarify:) )

let's try with v2

@sikehish
Copy link

sikehish commented Oct 20, 2023

Hi @ad1992 . Ive created a PR. Please review it and let me know if any changes are to be made.

UPDATE: Everything's working fine, but for some reason, the Code Analysis tool is throwing an error "Expected RBRACE" in css file, although braces are in place. I believe there's an issue with CSSLint which codacy is making use of.

You can try it out and let me know if any changes are to be made. Everything's working smoothly on my end.

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

No branches or pull requests

3 participants