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

Added User Documentation #282

Merged
merged 2 commits into from
Jul 27, 2021

Conversation

pragatijain
Copy link
Contributor

Fixes #

Ref #

Changes done:

  • Task 1

Screenshots:

Preview Link(s):

✅️ By submitting this PR, I have verified the following

  • Checked to see if a similar PR has already been opened 🤔️
  • Reviewed the contributing guidelines 🔍️
  • Sample preview link added (add a link from the checks tab after checks complete)
  • Tried Squashing the commits into one

Copy link
Member

@Shivansh2407 Shivansh2407 left a comment

Choose a reason for hiding this comment

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

Great Work Done @pragatijain . There are some updates to be done as mentioned below. Also I think we can remove the pages that are not being used at all.
I and @satu0king will make sure to add the video links accordingly. Also Satvik, Can we push it to betadocs or something, to fully Test and then merge it with Master ( Or should I take it on Localhost, try and test it and then merge it with master). Do let me know your views on this.

docs/README.md Outdated Show resolved Hide resolved
docs2/groups.md Outdated Show resolved Hide resolved
@Shivansh2407
Copy link
Member

Shivansh2407 commented Dec 21, 2020

It would be better if you can Clean up this repository a bit @pragatijain , removing the old/unnecessary files, then we will be good to go. Also do we require the /docs folder now? If not then remove it and rename the /docs2 to /docs so that it will be easier to deploy and preview the changes. Let me know your views @satu0king

@pragatijain
Copy link
Contributor Author

It would be better if you can Clean up this repository a bit @pragatijain , removing the old/unnecessary files, then we will be good to go. Also do we require the /docs folder now? If not then remove it and rename the /docs2 to /docs so that it will be easier to deploy and preview the changes. Let me know your views @satu0king

ok! Will do it.

@pragatijain
Copy link
Contributor Author

I deleted the old docs folder and updated the different sections where the numbering was broken. Please add video links as preferred.

@pranay-simejia
Copy link
Contributor

pranay-simejia commented Mar 25, 2021

src of images needs to be changed. For example: from /chapter2/images/img_chapter2/2.57.png to /images/img_chapter2/2.57.png .
As the images folder in the root dir.
@Shivansh2407 do you want me to fix this?

@pranay-simejia
Copy link
Contributor

Table and table text not supporting dark mode.
@Shivansh2407, shall I fix this?

image

@Shivansh2407 Shivansh2407 mentioned this pull request Mar 26, 2021
5 tasks
This was referenced Apr 6, 2021
@tachyons tachyons changed the base branch from master to documentation_revamp July 27, 2021 11:11
@tachyons tachyons merged commit ab44702 into CircuitVerse:documentation_revamp Jul 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet

4 participants