-
Notifications
You must be signed in to change notification settings - Fork 272
added verilog docs #438
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
base: master
Are you sure you want to change the base?
added verilog docs #438
Conversation
WalkthroughAdds README subsections for local deployment (Docusaurus and Docsify). Reorganizes sidebar: Chapter 8 repurposed as Verilog content; former Chapter 8 support items moved to a new Chapter 9. Updates front-matter ids for moved docs under Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.md (1)
26-31
: Clarify Docsify steps and standardize command block.Make the “cd” step explicit and present commands in a single fenced block. Keep Python 2 note only if you still support it.
Apply this diff:
-### Docsify - -To view the docs in offline mode, navigate to `/docs` folder and run -`python3 -m http.server` (for python3.x) or -`python -m SimpleHTTPServer 8000` (for python2.x) or -`python -m http.server` +### Docsify + +To view the docs locally: +```sh +cd docs +# Python 3 +python3 -m http.server 8000 +# or (legacy Python 2) +python -m SimpleHTTPServer 8000 +```sidebars.js (1)
86-88
: Align ID naming with existing convention.Other chapters often use “chapterX/chapterX-...” IDs. Consider renaming for consistency (optional).
Example diff (if you adopt the convention):
- { type: 'doc', id: 'chapter8/1circuittoverilog', label: 'Circuit to Verilog' }, - { type: 'doc', id: 'chapter8/2verilogtocircuit', label: 'Verilog to Circuit' }, + { type: 'doc', id: 'chapter8/chapter8-circuittoverilog', label: 'Circuit to Verilog' }, + { type: 'doc', id: 'chapter8/chapter8-verilogtocircuit', label: 'Verilog to Circuit' },Note: This requires matching file paths/frontmatter updates.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
README.md
(1 hunks)sidebars.js
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~21-~21: There might be a mistake here.
Context: ...l Deployment for testing ### Docusaurus To Start the dcusarus server: > npm inst...
(QB_NEW_EN)
[grammar] ~22-~22: Ensure spelling is correct
Context: ...or testing ### Docusaurus To Start the dcusarus server: > npm install > npm start ### ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~22-~22: There might be a mistake here.
Context: ...Docusaurus To Start the dcusarus server: > npm install > npm start ### Docsify To...
(QB_NEW_EN)
[grammar] ~23-~23: There might be a mistake here.
Context: ...Start the dcusarus server: > npm install > npm start ### Docsify To view the do...
(QB_NEW_EN)
🔇 Additional comments (2)
sidebars.js (2)
84-89
: Sidebar reorg to “Chapter 8: Verilog Support” looks good.The category and items are clear and scoped to Verilog.
91-99
: Verified: Chapter 9 docs exist with correct implicit IDs; no legacy Chapter 8 links found.All four files (
docs/chapter9/1onlineforums.md
,2cvfaq.md
,3cverrormessages.md
,4shortcuts.md
) are present and will resolve to the sidebar IDs by their paths. Nochapter8/...
references remain in the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (1)
README.md (1)
21-26
: Typo/formatting fix confirmed — looks good.The Docusaurus section now uses correct spelling, lowercase “start,” and a fenced code block. Thanks for resolving the earlier feedback.
🧹 Nitpick comments (2)
README.md (2)
21-26
: Add prerequisites and default URL to reduce setup friction.Include Node.js LTS and npm requirements and tell readers where the dev server runs.
Apply this diff:
### Docusaurus -To start the Docusaurus server: +Prerequisites: Node.js 18+ (LTS) and npm. +To start the Docusaurus dev server (defaults to http://localhost:3000): ```sh npm install npm start--- `28-29`: **Clarify that Docsify is an alternative local preview path.** A one-liner helps readers choose between Docusaurus and Docsify flows. Apply this diff: ```diff ### Docsify - +Use this as a lightweight alternative to preview the static docs without the Docusaurus dev server:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (5)
README.md
(1 hunks)docs/chapter9/1onlineforums.mdx
(1 hunks)docs/chapter9/2cvfaq.mdx
(1 hunks)docs/chapter9/3cverrormessages.mdx
(1 hunks)docs/chapter9/4shortcuts.mdx
(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- docs/chapter9/1onlineforums.mdx
- docs/chapter9/3cverrormessages.mdx
- docs/chapter9/2cvfaq.mdx
- docs/chapter9/4shortcuts.mdx
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~21-~21: There might be a mistake here.
Context: ...l Deployment for testing ### Docusaurus To start the Docusaurus server: ```sh np...
(QB_NEW_EN)
Changes done:
Summary by CodeRabbit