docs: Add comprehensive MkDocs documentation with GitHub Pages deployment#181
Merged
docs: Add comprehensive MkDocs documentation with GitHub Pages deployment#181
Conversation
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension. |
| python-version: '3.11' | ||
|
|
||
| - name: Install Poetry | ||
| uses: snok/install-poetry@v1 |
There was a problem hiding this comment.
Workflow should not use version pinning for third-party actions
on resource jobs.deploy.steps[2].uses
More Details
This rule checks that GitHub workflow does not use version pinning on third-party actions. This rule fails when the workflow contains steps that use third-party actions referenced by version tags (like @v1, @v2.3, @v4) instead of specific commits. Using version-tagged actions creates a supply chain security risk, as the version tag could be modified by the action's maintainer to point to malicious code after the calling workflow is created. Even when using specific version tags, the tag could be moved to point to malicious code. To prevent this risk, always pin third-party actions to specific commit SHAs to ensure the exact code being executed is locked and immutable.
Expected
Workflow job 'deploy' step[2] should pin third-party action to a commit SHA rather than a version tag
Found
Workflow job 'deploy' step[2] uses version-tagged third-party action: 'snok/install-poetry@v1'
Security Frameworks: wf-id-1, wf-id-175
Rule ID: 7d431072-4eef-466b-b469-4b7681d8f9a1
To ignore this finding as an exception, reply to this conversation with #wiz_ignore reason
If you'd like to ignore this finding in all future scans, add an exception in the .wiz file (learn more) or create an Ignore Rule (learn more).
To get more details on how to remediate this issue using AI, reply to this conversation with #wiz remediate
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.
Pull Request
📝 Summary
This PR establishes a complete MkDocs-based documentation system for Titan CLI with automated GitHub Pages deployment. The documentation covers core concepts (workflows, plugins, AI integration), detailed guides for all major workflows, and comprehensive references for configuration, steps, and hooks.
🔧 Changes Made
🧪 Testing
poetry run pytest)make test)titan-devDocumentation was manually tested by:
make docs-serveto verify local renderingmake docs-buildto ensure clean build output📊 Logs
✅ Checklist