CircuitVerseDocs icon indicating copy to clipboard operation
CircuitVerseDocs copied to clipboard
verified publisher icon CircuitVerse

Move from docsify to docusaurus #383

Open tachyons opened this issue 9 months ago • 3 comments

Fixes #

Ref #

Changes done:

  • [x] 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

tachyons avatar Mar 14 '25 09:03 tachyons

@salmoneatenbybear I've updated your PR with some changes to keep original file history, you can now take over this PR to fix remaining issues including changes made after you started working on this project.

tachyons avatar Mar 14 '25 09:03 tachyons

@tachyons Thankyou. Working on this...

salmoneatenbybear avatar Mar 14 '25 10:03 salmoneatenbybear

@Asrani-Aman absolutely

salmoneatenbybear avatar Mar 15 '25 09:03 salmoneatenbybear

No

On Thu, Apr 17, 2025 at 11:54 AM Aditya Singh @.***> wrote:

@.**** commented on this pull request.

In CircuitVerse-Documentation/docs/chapter2/4bestpracticescv.mdx https://github.com/CircuitVerse/CircuitVerseDocs/pull/405#discussion_r2048315226 :

@@ -20,4 +20,4 @@ description: "Best practices for using the CircuitVerse simulator effectively."

  1. Copy paste your circuits: Cross-project copy and paste is supported to include whole or parts of circuits across different circuit tabs or across different project URLs.

-5. Annotate your circuits: As your design goes through multiple revisions, use different annotation tools available within the CircuitVerse simulator to add the version number, date, amendments, and different group members involved. Refer to Chapter 4 to learn more about the different annotation elements available within the CV simulator. +5. Annotate your circuits: As your design goes through multiple revisions, use different annotation tools available within the CircuitVerse simulator to add the version number, date, amendments, and different group members involved. Refer to Chapter 4 to learn more about the different annotation elements available within the CV simulator.

If keeping history is important, I suggest we should do a subtree merge ? Would this be fine @tachyons https://github.com/tachyons

— Reply to this email directly, view it on GitHub https://github.com/CircuitVerse/CircuitVerseDocs/pull/405#discussion_r2048315226, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAXYAEFG3SV6ZOC3IMVSIP32Z5CLDAVCNFSM6AAAAABZAI6YQSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDONZUG4YDMNRRGQ . You are receiving this because you were mentioned.Message ID: @.***>

-- Aboobacker MK w:www.aboobacker.in

tachyons avatar Apr 17 '25 06:04 tachyons

@tachyons ok noted.

salmoneatenbybear avatar Apr 17 '25 06:04 salmoneatenbybear

trying to update this PR by https://github.com/CircuitVerse/CircuitVerseDocs/pull/421 can you help me @tachyons ?

salmoneatenbybear avatar Apr 17 '25 16:04 salmoneatenbybear

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This update introduces a major overhaul of the documentation site infrastructure and content. It migrates the project to a Docusaurus-based static site, adds comprehensive configuration and styling files, and updates all documentation markdown files with metadata, improved formatting, and standardized image paths. Navigation and search are restructured, and legacy sidebar and README files are removed.

Changes

File(s) Change Summary
.gitignore Expanded ignore list for dependencies, build outputs, logs, and environment files; removed .idea/ from ignored items.
config.json New search indexing configuration targeting the documentation site with crawl rules and extraction logic.
docusaurus.config.js, sidebars.js Added Docusaurus site and sidebar configuration with navigation, theming, and Algolia search integration.
package.json New project manifest with scripts, dependencies, devDependencies, browserslist, and engines for Docusaurus site.
netlify.toml Updated build output directory to build/ and added build command for Netlify deployment.
src/css/theme.css, src/css/darkTheme.css Added custom CSS for toggles, layout, table cell backgrounds, and responsive adjustments.
docs/README.md, docs/_sidebar.md Removed legacy documentation README and sidebar navigation files.
docs/chapter1/..., docs/chapter2/..., docs/chapter3/..., docs/chapter4/..., docs/chapter5/..., docs/chapter6/..., docs/chapter7/... All documentation markdown files updated: added front matter metadata, standardized image paths to /img/, reformatted figure captions, tables, and iframes, improved formatting, and minor textual cleanup.
📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2daf49fec5a5d527379d4bb2227063ef1f4afbfa and 0f7034ef716d03a83a4214a10c377c273765b59b.

⛔ Files ignored due to path filters (175)
  • package-lock.json is excluded by !**/package-lock.json
  • static/img/cvlogo.svg is excluded by !**/*.svg
  • static/img/favicon.ico is excluded by !**/*.ico
  • static/img/img_chapter1/1.1.png is excluded by !**/*.png
  • static/img/img_chapter1/1.2.png is excluded by !**/*.png
  • static/img/img_chapter1/1.3.png is excluded by !**/*.png
  • static/img/img_chapter1/1.4.png is excluded by !**/*.png
  • static/img/img_chapter2/2.1.png is excluded by !**/*.png
  • static/img/img_chapter2/2.11.png is excluded by !**/*.png
  • static/img/img_chapter2/2.12.png is excluded by !**/*.png
  • static/img/img_chapter2/2.13.png is excluded by !**/*.png
  • static/img/img_chapter2/2.14.png is excluded by !**/*.png
  • static/img/img_chapter2/2.15.png is excluded by !**/*.png
  • static/img/img_chapter2/2.16.png is excluded by !**/*.png
  • static/img/img_chapter2/2.19.png is excluded by !**/*.png
  • static/img/img_chapter2/2.2.png is excluded by !**/*.png
  • static/img/img_chapter2/2.20.png is excluded by !**/*.png
  • static/img/img_chapter2/2.21.png is excluded by !**/*.png
  • static/img/img_chapter2/2.22.png is excluded by !**/*.png
  • static/img/img_chapter2/2.23.png is excluded by !**/*.png
  • static/img/img_chapter2/2.24.png is excluded by !**/*.png
  • static/img/img_chapter2/2.25.png is excluded by !**/*.png
  • static/img/img_chapter2/2.26.png is excluded by !**/*.png
  • static/img/img_chapter2/2.27.png is excluded by !**/*.png
  • static/img/img_chapter2/2.3.png is excluded by !**/*.png
  • static/img/img_chapter2/2.30.png is excluded by !**/*.png
  • static/img/img_chapter2/2.31.png is excluded by !**/*.png
  • static/img/img_chapter2/2.32.png is excluded by !**/*.png
  • static/img/img_chapter2/2.33.png is excluded by !**/*.png
  • static/img/img_chapter2/2.34.png is excluded by !**/*.png
  • static/img/img_chapter2/2.35.png is excluded by !**/*.png
  • static/img/img_chapter2/2.36.png is excluded by !**/*.png
  • static/img/img_chapter2/2.37.png is excluded by !**/*.png
  • static/img/img_chapter2/2.38.png is excluded by !**/*.png
  • static/img/img_chapter2/2.4.png is excluded by !**/*.png
  • static/img/img_chapter2/2.41.png is excluded by !**/*.png
  • static/img/img_chapter2/2.42.png is excluded by !**/*.png
  • static/img/img_chapter2/2.43.png is excluded by !**/*.png
  • static/img/img_chapter2/2.44.png is excluded by !**/*.png
  • static/img/img_chapter2/2.45.png is excluded by !**/*.png
  • static/img/img_chapter2/2.46.png is excluded by !**/*.png
  • static/img/img_chapter2/2.47.png is excluded by !**/*.png
  • static/img/img_chapter2/2.48.1.png is excluded by !**/*.png
  • static/img/img_chapter2/2.48.2.png is excluded by !**/*.png
  • static/img/img_chapter2/2.48.3.png is excluded by !**/*.png
  • static/img/img_chapter2/2.48.4.png is excluded by !**/*.png
  • static/img/img_chapter2/2.48.png is excluded by !**/*.png
  • static/img/img_chapter2/2.49.png is excluded by !**/*.png
  • static/img/img_chapter2/2.5.png is excluded by !**/*.png
  • static/img/img_chapter2/2.50.png is excluded by !**/*.png
  • static/img/img_chapter2/2.52.png is excluded by !**/*.png
  • static/img/img_chapter2/2.53.png is excluded by !**/*.png
  • static/img/img_chapter2/2.54.png is excluded by !**/*.png
  • static/img/img_chapter2/2.55.png is excluded by !**/*.png
  • static/img/img_chapter2/2.56.png is excluded by !**/*.png
  • static/img/img_chapter2/2.57.png is excluded by !**/*.png
  • static/img/img_chapter2/2.58.png is excluded by !**/*.png
  • static/img/img_chapter2/2.59.png is excluded by !**/*.png
  • static/img/img_chapter2/2.6.png is excluded by !**/*.png
  • static/img/img_chapter2/2.60.png is excluded by !**/*.png
  • static/img/img_chapter2/2.61.png is excluded by !**/*.png
  • static/img/img_chapter2/2.62.png is excluded by !**/*.png
  • static/img/img_chapter2/2.63.png is excluded by !**/*.png
  • static/img/img_chapter2/2.64.png is excluded by !**/*.png
  • static/img/img_chapter2/2.65.png is excluded by !**/*.png
  • static/img/img_chapter2/2.66.png is excluded by !**/*.png
  • static/img/img_chapter2/2.67.png is excluded by !**/*.png
  • static/img/img_chapter2/2.68.png is excluded by !**/*.png
  • static/img/img_chapter2/2.69.png is excluded by !**/*.png
  • static/img/img_chapter2/2.7.png is excluded by !**/*.png
  • static/img/img_chapter2/2.8.png is excluded by !**/*.png
  • static/img/img_chapter2/about_sso.png is excluded by !**/*.png
  • static/img/img_chapter2/lms_integration/lms_checkbox.png is excluded by !**/*.png
  • static/img/img_chapter2/lms_integration/show_lms_link.png is excluded by !**/*.png
  • static/img/img_chapter2/lms_integration/tool_key.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/Assign.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/SingleSignOnButton.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/about_sso.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/client-access-settings-keycloak.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/client-signature-required.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/create-client-keycloak.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/create-realm-keycloak.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/create_app_integration.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/credentials.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/navigate_to_applicattion.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/step5.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/step6.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/step7.png is excluded by !**/*.png
  • static/img/img_chapter2/sso_integration/step_4_select_saml2.0.png is excluded by !**/*.png
  • static/img/img_chapter3/3.1.png is excluded by !**/*.png
  • static/img/img_chapter3/3.10.png is excluded by !**/*.png
  • static/img/img_chapter3/3.11.png is excluded by !**/*.png
  • static/img/img_chapter3/3.12.png is excluded by !**/*.png
  • static/img/img_chapter3/3.13.png is excluded by !**/*.png
  • static/img/img_chapter3/3.14.png is excluded by !**/*.png
  • static/img/img_chapter3/3.15.png is excluded by !**/*.png
  • static/img/img_chapter3/3.16.png is excluded by !**/*.png
  • static/img/img_chapter3/3.17.png is excluded by !**/*.png
  • static/img/img_chapter3/3.18.png is excluded by !**/*.png
  • static/img/img_chapter3/3.19.png is excluded by !**/*.png
  • static/img/img_chapter3/3.2.png is excluded by !**/*.png
  • static/img/img_chapter3/3.20.png is excluded by !**/*.png
  • static/img/img_chapter3/3.21.png is excluded by !**/*.png
  • static/img/img_chapter3/3.22.png is excluded by !**/*.png
  • static/img/img_chapter3/3.23.png is excluded by !**/*.png
  • static/img/img_chapter3/3.3.png is excluded by !**/*.png
  • static/img/img_chapter3/3.4.png is excluded by !**/*.png
  • static/img/img_chapter3/3.5.png is excluded by !**/*.png
  • static/img/img_chapter3/3.6.png is excluded by !**/*.png
  • static/img/img_chapter3/3.7.png is excluded by !**/*.png
  • static/img/img_chapter3/3.8.png is excluded by !**/*.png
  • static/img/img_chapter3/3.9.png is excluded by !**/*.png
  • static/img/img_chapter4/4.1.png is excluded by !**/*.png
  • static/img/img_chapter4/4.10.png is excluded by !**/*.png
  • static/img/img_chapter4/4.11.png is excluded by !**/*.png
  • static/img/img_chapter4/4.12.png is excluded by !**/*.png
  • static/img/img_chapter4/4.13.png is excluded by !**/*.png
  • static/img/img_chapter4/4.14.png is excluded by !**/*.png
  • static/img/img_chapter4/4.15.png is excluded by !**/*.png
  • static/img/img_chapter4/4.16.png is excluded by !**/*.png
  • static/img/img_chapter4/4.17.png is excluded by !**/*.png
  • static/img/img_chapter4/4.18.png is excluded by !**/*.png
  • static/img/img_chapter4/4.19.png is excluded by !**/*.png
  • static/img/img_chapter4/4.2.png is excluded by !**/*.png
  • static/img/img_chapter4/4.20.png is excluded by !**/*.png
  • static/img/img_chapter4/4.21.png is excluded by !**/*.png
  • static/img/img_chapter4/4.22.png is excluded by !**/*.png
  • static/img/img_chapter4/4.23.png is excluded by !**/*.png
  • static/img/img_chapter4/4.24.png is excluded by !**/*.png
  • static/img/img_chapter4/4.3.png is excluded by !**/*.png
  • static/img/img_chapter4/4.4.png is excluded by !**/*.png
  • static/img/img_chapter4/4.5.png is excluded by !**/*.png
  • static/img/img_chapter4/4.6.png is excluded by !**/*.png
  • static/img/img_chapter4/4.7.png is excluded by !**/*.png
  • static/img/img_chapter4/4.8.png is excluded by !**/*.png
  • static/img/img_chapter4/4.9.png is excluded by !**/*.png
  • static/img/img_chapter5/5.1.png is excluded by !**/*.png
  • static/img/img_chapter5/5.2.png is excluded by !**/*.png
  • static/img/img_chapter5/5.3.png is excluded by !**/*.png
  • static/img/img_chapter6/6.1.png is excluded by !**/*.png
  • static/img/img_chapter6/6.2.png is excluded by !**/*.png
  • static/img/img_chapter6/6.3.png is excluded by !**/*.png
  • static/img/img_chapter7/7.1.png is excluded by !**/*.png
  • static/img/img_chapter7/7.10.png is excluded by !**/*.png
  • static/img/img_chapter7/7.11.png is excluded by !**/*.png
  • static/img/img_chapter7/7.12.png is excluded by !**/*.png
  • static/img/img_chapter7/7.13.png is excluded by !**/*.png
  • static/img/img_chapter7/7.14.png is excluded by !**/*.png
  • static/img/img_chapter7/7.15.png is excluded by !**/*.png
  • static/img/img_chapter7/7.16.png is excluded by !**/*.png
  • static/img/img_chapter7/7.17.png is excluded by !**/*.png
  • static/img/img_chapter7/7.18.png is excluded by !**/*.png
  • static/img/img_chapter7/7.19.png is excluded by !**/*.png
  • static/img/img_chapter7/7.2.png is excluded by !**/*.png
  • static/img/img_chapter7/7.20.png is excluded by !**/*.png
  • static/img/img_chapter7/7.21.png is excluded by !**/*.png
  • static/img/img_chapter7/7.22.png is excluded by !**/*.png
  • static/img/img_chapter7/7.3.png is excluded by !**/*.png
  • static/img/img_chapter7/7.4.png is excluded by !**/*.png
  • static/img/img_chapter7/7.5.png is excluded by !**/*.png
  • static/img/img_chapter7/7.6.png is excluded by !**/*.png
  • static/img/img_chapter7/7.7.png is excluded by !**/*.png
  • static/img/img_chapter7/7.8.png is excluded by !**/*.png
  • static/img/img_chapter7/7.9.png is excluded by !**/*.png
  • static/img/img_chapter7/click_attach.png is excluded by !**/*.png
  • static/img/img_chapter7/detailed.png is excluded by !**/*.png
  • static/img/img_chapter7/location.jpg is excluded by !**/*.jpg
  • static/img/img_chapter7/make_test.png is excluded by !**/*.png
  • static/img/img_chapter7/manual.png is excluded by !**/*.png
  • static/img/img_chapter7/name_elements.png is excluded by !**/*.png
  • static/img/img_chapter7/plus_icon_circuittab.png is excluded by !**/*.png
  • static/img/img_chapter7/rectangle_icon_annotation.png is excluded by !**/*.png
  • static/img/img_chapter7/runall.png is excluded by !**/*.png
  • static/img/img_chapter8/8.1.png is excluded by !**/*.png
  • static/img/img_chapter8/8.2.png is excluded by !**/*.png
📒 Files selected for processing (41)
  • .gitignore (1 hunks)
  • config.json (1 hunks)
  • docs/README.md (0 hunks)
  • docs/_sidebar.md (0 hunks)
  • docs/chapter1/1introduction.md (1 hunks)
  • docs/chapter1/2keyfeatures.md (1 hunks)
  • docs/chapter1/3systemrequirments.md (1 hunks)
  • docs/chapter2/1gettingstarted.md (1 hunks)
  • docs/chapter2/2cvforeducators.md (2 hunks)
  • docs/chapter2/3lmsintegration.md (6 hunks)
  • docs/chapter2/4bestpracticescv.md (1 hunks)
  • docs/chapter2/5ssointegration.md (3 hunks)
  • docs/chapter3/1introduction.md (1 hunks)
  • docs/chapter3/2understandingcvsimulator.md (1 hunks)
  • docs/chapter3/canvas.md (1 hunks)
  • docs/chapter3/circuitelements.md (1 hunks)
  • docs/chapter3/circuittabs.md (1 hunks)
  • docs/chapter3/menubar.md (1 hunks)
  • docs/chapter3/properties.md (1 hunks)
  • docs/chapter3/quickaccesspanel.md (1 hunks)
  • docs/chapter3/reportsystem.md (1 hunks)
  • docs/chapter3/wires.md (1 hunks)
  • docs/chapter4/1introduction.md (1 hunks)
  • docs/chapter4/2input.md (2 hunks)
  • docs/chapter4/3output.md (2 hunks)
  • docs/chapter4/4gates.md (8 hunks)
  • docs/chapter4/5muxandplex.md (2 hunks)
  • docs/chapter4/6sequentialelements.md (3 hunks)
  • docs/chapter4/7annotation.md (1 hunks)
  • docs/chapter4/8misc.md (3 hunks)
  • docs/chapter5/usingeditlayout.md (1 hunks)
  • docs/chapter5/usingsubcircuits.md (1 hunks)
  • docs/chapter6/delayvsclock.md (1 hunks)
  • docs/chapter6/timingdiagram.md (2 hunks)
  • docs/chapter7/1cvdesignprocess.md (1 hunks)
  • docusaurus.config.js (1 hunks)
  • netlify.toml (1 hunks)
  • package.json (1 hunks)
  • sidebars.js (1 hunks)
  • src/css/darkTheme.css (1 hunks)
  • src/css/theme.css (1 hunks)
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar May 27 '25 08:05 coderabbitai[bot]