Skip to content

Docs/docusaurus setup - #272

Open
yash-khaitan wants to merge 3 commits into
mainfrom
docs/docusaurus-setup
Open

yash-khaitan wants to merge 3 commits into
mainfrom
docs/docusaurus-setup

Conversation

@yash-khaitan

Copy link
Copy Markdown
Contributor

SUMMARY

What this pr is for?

  • This PR introduce Docusaurus into our application.
  • Docusaurus creates a nice-looking react static page for all the documentation in our project.
  • We will also publish it to Github pages for easy access.

Issue Link

Link the Issue for which this PR was raised
#268

Changes Summary

What changes has been done to solve the issue

  • Added Docusaurus.
  • Added workflow for deployment to Github Pages.

Testing Done

How has the solution been tested?

  • Generated Site ran fine in local with all the documents accessible from the site

Pull Request Checklist

Tasks Yes/No
Issue Linked?
Timeline of the Issue is updated?
Do these changes affect local development in anyway? (if yes mention effects in additional comments)

Additional Comments

Anything else regarding this PR

@SuvabrataChowdhury SuvabrataChowdhury left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Feels like some redundant images re coming part of this change. please remove if not necessary.

Where are we mentioning the path for the .md docs? Can you please attach some screenshots?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this looks like a generated card.. please remove if not required.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same for this.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

if not used.. please remove.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

same here

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

and here.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this one too should be removed.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

so as this one.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

this one as well.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

why is this empty file required?

This branch has not been deployed

No deployments
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.

2 participants