Conversation
Replace the flat, API-centric doc structure with a user-first, task-oriented layout organized around what users actually do: New top-level sections - getting-started/ installation + 5-minute quickstart (CLI-first) - importing/ Verilator, cocotb-coverage, AVL — each in its own page - working-with-coverage/ merge, TUI explorer, show commands, compare - reporting/ HTML report and CI/CD format export - cicd/ GitHub Actions, GitLab CI, Jenkins — copy-pasteable - ai-integration/ MCP server (framed around what you can ask, not tool list) - reference/ Developer content separated from user content - python-api/ Full OO API: 25 classes/enums, all autodoc'd - formats/ XML, YAML, SQLite schema specs - report-formats/ HTML and JSON report format specs conf.py changes - Add sphinx.ext.napoleon so Google-style docstrings parse correctly - Add sphinx_design for tab-set directives in quickstart Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
sphinx_design is needed for tab-set directives added in quickstart.rst. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.