docs: update security and readme files [skip:ci, skip:test:long-runni…#436
Merged
omid-aignostics merged 2 commits intomainfrom Feb 19, 2026
Merged
docs: update security and readme files [skip:ci, skip:test:long-runni…#436omid-aignostics merged 2 commits intomainfrom
omid-aignostics merged 2 commits intomainfrom
Conversation
…ng, skip:test:matrix-runner, skip:test:very-long-running]
There was a problem hiding this comment.
Pull request overview
This PR updates documentation presentation (Mermaid diagram theming + Sphinx CSS inclusion), refreshes some generated/auxiliary docs (OpenAPI YAML, CLI reference, attributions), and applies minor import ordering changes in the platform module/tests.
Changes:
- Add Sphinx custom CSS and Mermaid init configuration to improve diagram rendering/visibility.
- Reformat/update several documentation artifacts (SECURITY.md, OpenAPI spec YAML, CLI reference, attributions) and remove the README’s MCP Server section.
- Reorder platform constants imports in
platformsettings code and tests.
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/aignostics/platform/settings_test.py | Reorders imported platform constants. |
| src/aignostics/platform/_settings.py | Reorders imported constants used by platform settings. |
| src/aignostics/platform/init.py | Reorders exports/imports of platform constants (also touches __all__). |
| docs/source/conf.py | Includes custom.css in Sphinx HTML build. |
| docs/source/_static/custom.css | Adds CSS to allow Mermaid diagrams to use full width. |
| docs/source/_static/openapi_v1.yaml | Reformats OpenAPI YAML content (currently appears to introduce invalid YAML). |
| docs/partials/README_main.md | Adds Mermaid init/theme configuration for the main README partial. |
| SECURITY.md | Formatting fixes and a typo correction. |
| README.md | Adds Mermaid init/theme configuration; removes MCP Server documentation and MCP glossary entry. |
| CLI_REFERENCE.md | Adds mcp command docs and updates some CLI help text formatting. |
| ATTRIBUTIONS.md | Updates dependency attributions/license text (large regen/update). |
Comments suppressed due to low confidence (1)
src/aignostics/platform/init.py:121
__all__contains many duplicated entries (e.g.DEFAULT_CPU_PROVISIONING_MODE,DEFAULT_GPU_PROVISIONING_MODE,DEFAULT_GPU_TYPE, etc.). This is harmless at runtime but makes the public surface noisy/confusing for users and for generated docs. Please deduplicate the list so each export appears once.
"DEFAULT_CPU_PROVISIONING_MODE",
"DEFAULT_CPU_PROVISIONING_MODE",
"DEFAULT_FLEX_START_MAX_RUN_DURATION_MINUTES",
"DEFAULT_GPU_PROVISIONING_MODE",
"DEFAULT_GPU_PROVISIONING_MODE",
"DEFAULT_GPU_TYPE",
"DEFAULT_GPU_TYPE",
"DEFAULT_MAX_GPUS_PER_SLIDE",
…est:long-running, skip:test:matrix-runner, skip:test:very-long-running]
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
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.
Uh oh!
There was an error while loading. Please reload this page.