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

Typographical and Grammatical Errors in Key Features Section of CircuitVerse Documentation #388

Open
Stitipragyanbarik opened this issue Jan 7, 2025 · 1 comment

Comments

@Stitipragyanbarik
Copy link

Describe the bug

The Key Features section of the CircuitVerse simulator documentation contains several typographical and grammatical errors. Below are the identified issues and their suggested corrections:

1-Typographical Errors:

"operating system dependent instructions" → "operating-system-dependent instructions"
"demanding multi bit widths" → "demanding multibit widths"

2-Grammatical Errors:

"timing diagram" → "timing diagrams" (plural for consistency).
"debug logical mistakes and race conditions" → "to debug logical mistakes and race conditions" (missing preposition).
Add a comma after "stable state": "stable state, and race conditions."

3-Clarity and Consistency Improvements:

Replace vague phrase: "something like this" in the Insert subcircuit subsection with:
"Hierarchical circuits can be created by nesting and reusing smaller circuits within larger designs."

To Reproduce

Steps to reproduce the behavior:
1-CircuitVerseDocs/docs/ chapter1/2keyfeatures.md
2- Navigate to the Key Features section of the documentation.
3-Observe the listed typos and grammatical inconsistencies.

Expected behavior

A clear and concise description of what you expected to happen.

The corrected documentation should be clear, concise, and grammatically accurate for a better understanding of the CircuitVerse simulator's features.

Screenshots/GIFs

If applicable, add screenshots or GIFs to help explain your problem.

Device Information [optional]:

  • OS:
  • Browser:
  • Version:

Additional context

Add any other context about the problem here.

These changes will improve the readability and professionalism of the documentation.

Are you working on this issue? (Yes)

@Stitipragyanbarik
Copy link
Author

Stitipragyanbarik commented Jan 7, 2025

cc : @tachyons , @Prerna-0202

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

No branches or pull requests

1 participant