feat: Automated reference documentation generation from Weave source

[mdlinville]

Overview

This PR implements an automated system for generating reference documentation from the Weave source code. It addresses the need to move away from static markdown files to dynamically generated documentation while avoiding the Socket Security issues identified in the previous approach.

Key Features

1. Service API Documentation: Uses Mintlify's native OpenAPI support (no custom processing)
2. Python SDK Documentation: Generated using lazydocs from any Weave version
3. TypeScript SDK Documentation: Generated using typedoc with markdown output
4. GitHub Action: Automated weekly updates with manual trigger support

Testing the Action

The workflow includes a temporary PR trigger for testing. When you push changes to this PR that modify:

• .github/workflows/generate-reference-docs.yml
• Any scripts/generate_*.py files
• scripts/requirements.txt

The action will run in test mode and:

1. Generate all documentation
2. Report what changes were found
3. Show what would happen in production (without creating a nested PR)

Check the Actions tab to see the test results.

Production Usage

Manual Trigger

1. Go to Actions → Generate Reference Documentation
2. Click "Run workflow"
3. Options:
   • weave_version: Specify a version tag (e.g., v0.50.0), commit SHA, or branch name (default: main)
   • create_pr: Whether to create a PR with changes (default: true)

Automatic Updates

• The workflow runs weekly every Monday at 00:00 UTC
• Automatically creates a PR if documentation changes are detected

Version Support

• Latest PyPI: Leave version empty or use latest
• Specific version: v0.50.0 or 0.50.0
• Commit SHA: Any valid Git commit hash
• Branch: main, feature/branch-name, etc.

Implementation Details

Improvements over previous approach:

• ✅ Minimal dependencies (only requests, lazydocs, pyyaml)
• ✅ No custom OpenAPI processing (uses Mintlify's native support)
• ✅ No Socket Security vulnerabilities
• ✅ Version-based generation (no need to clone repository for Python SDK)
• ✅ Cleaner, more maintainable code

Scripts:

• generate_service_api_spec.py: Downloads OpenAPI spec from production
• generate_python_sdk_docs.py: Installs Weave version and generates docs
• generate_typescript_sdk_docs.py: Downloads source and generates docs

Important Notes

⚠️ Before merging: Remove the pull_request trigger from the workflow (it's marked with a comment)

Checklist

• Scripts are executable and tested locally
• GitHub Action includes test mode for PRs
• Concurrency controls prevent multiple runs
• Documentation updated with usage instructions
• Version-based approach eliminates need for repo cloning (except TypeScript)

[socket-security]

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	pypi/​requests@​2.32.4
	pypi/​lazydocs@​0.4.8
	pypi/​pyyaml@​6.0.2

View full report

[socket-security]

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action	Severity	Alert (click for details)
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
Warn		pypi/[email protected] has a License Policy Violation. License: Python-2.0.1 (mypy-1.17.0.dist-info/licenses/LICENSE) From: ? → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] → pypi/[email protected] ℹ Read more on: This package | This alert | What is a license policy violation? Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected]. Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license. Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.
See 13 more rows in the dashboard

View full report

[mdlinville]

Broken Link Validation Issue

The PR is currently failing the "Mintlify Validation" check due to pre-existing broken links in the repository that are unrelated to this PR's changes.

Issue Created

I've created Issue #11 to track the broken links that need to be fixed in the main branch.

Current Status

Unfortunately, Mintlify doesn't provide a configuration option to temporarily disable link validation. The broken links are in:

• CLAUDE.md
• Various files in the cookbooks/ directory

Recommendations

1. Option 1: Fix the broken links in the main branch first (tracked in Fix broken links in main branch #11)
2. Option 2: Contact Mintlify support to temporarily disable link validation for this repository
3. Option 3: Merge despite the failing check if the team is comfortable with it, knowing the failures are unrelated to these changes

The documentation generation system implemented in this PR is working correctly - the failures are solely due to pre-existing issues in the repository.