Enhance documentation and project structure #4
Conversation
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
- Added `generate_api_docs.py` script for automatic API documentation generation. - Updated `.gitignore` to exclude the `site/` directory. - Modified `Makefile` to include commands for building, serving, and deploying documentation. - Created `mkdocs.yml` for documentation configuration. - Added various documentation files including guides, API references, and examples. - Established `requirements-docs.txt` for documentation dependencies. - Implemented a setup script for the documentation environment.
- Added new features to the MkDocs configuration, including additional content tabs and code selection options. - Replaced the deprecated `mkdocs-mermaid2-plugin` with `mkdocs-mermaid` in the requirements. - Removed the obsolete README.md file from the documentation directory. - Enhanced user guide with sections on custom protocol handlers and distributed testing. - Updated API documentation filters to exclude specific internal modules and improved overall structure.
…ture diagram - Added `mkdocs-mermaid2` to `requirements-docs.txt` for enhanced diagram support. - Updated the architecture diagram in `index.md` to reflect changes in the configuration flow and components.
subhamagrawal7
requested changes
Aug 10, 2025
- Expanded the Request Configuration section to clarify support for both HTTP and WebSocket requests across multiple documentation files. - Updated prerequisites in the Quick Start guide to require Python 3.9 or higher. - Enhanced user guide and configuration reference with detailed examples for WebSocket requests and a new plugin feature in development. - Improved overall clarity and consistency in documentation regarding request handling and configuration options.
- Corrected the links to the API Reference in the Development Guide, Examples, and User Guide to point to the updated path (/gradual/api/overview/). - Ensured consistency across documentation for easier navigation and access to technical information.
subhamagrawal7
left a comment
subhamagrawal7
left a comment
There was a problem hiding this comment.
Can we modify the generate_api_docs.py or some automated way to ensure markdown consistency such as extra newlines so that at all places the steps numbering which should be at different lines is automatically fixed? Else we would have to manually modify all the docstrings as well for the functions.
- Updated flowchart styles in the configuration reference documentation to include font size specifications for better readability. - Added new styles for additional nodes in the ramp-up flowcharts to maintain consistency and improve visual clarity.
Contributor
Author
This will take good amount of efforts. I have created a github issue, to address this separately if we think this is causing too much trouble. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
generate_api_docs.pyscript for automatic API documentation generation..gitignoreto exclude thesite/directory.Makefileto include commands for building, serving, and deploying documentation.mkdocs.ymlfor documentation configuration.requirements-docs.txtfor documentation dependencies.Type of Change
Testing
Checklist
Additional Context