Skip to content

docs: Add comprehensive MkDocs documentation with GitHub Pages deployment#181

Merged
finxo merged 3 commits intomasterfrom
docs/create_docs
Mar 13, 2026
Merged

docs: Add comprehensive MkDocs documentation with GitHub Pages deployment#181
finxo merged 3 commits intomasterfrom
docs/create_docs

Conversation

@finxo
Copy link
Collaborator

@finxo finxo commented Mar 9, 2026

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

  • Added MkDocs configuration with Material theme and extensive navigation structure
  • Created comprehensive documentation covering concepts, guides, and reference materials
  • Implemented GitHub Actions workflow for automated docs deployment to GitHub Pages
  • Added Makefile targets for local docs serving, building, and deployment
  • Configured Poetry with docs dependency group (mkdocs, mkdocs-material, pymdown-extensions)
  • Removed legacy Jekyll configuration (_config.yml)
  • Documented all built-in workflows (commit-ai, pr-ai, jira-analyze, etc.) with examples
  • Created reference documentation for configuration files, step types, and hook system
  • Added troubleshooting guides and FAQ section
  • Included getting started guide, installation instructions, and development setup

🧪 Testing

  • Unit tests added/updated (poetry run pytest)
  • All tests passing (make test)
  • Manual testing with titan-dev

Documentation was manually tested by:

  • Running make docs-serve to verify local rendering
  • Testing make docs-build to ensure clean build output
  • Validating all internal links and navigation structure
  • Reviewing rendered output in browser for formatting and readability

📊 Logs

  • No new log events

✅ Checklist

  • Self-review done
  • Follows the project's logging rules (no secrets, no content in logs)
  • New and existing tests pass
  • Documentation updated if needed

@finxo finxo self-assigned this Mar 9, 2026
@wiz-c04d923138
Copy link

wiz-c04d923138 bot commented Mar 9, 2026

Wiz Scan Summary

Scanner Findings
Vulnerability Finding Vulnerabilities -
Data Finding Sensitive Data -
Secret Finding Secrets -
IaC Misconfiguration IaC Misconfigurations 1 Low
SAST Finding SAST Findings -
Software Management Finding Software Management Findings -
Total 1 Low

View scan details in Wiz

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Low IaC Finding

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

@finxo finxo merged commit a30f0a4 into master Mar 13, 2026
5 checks passed
@finxo finxo deleted the docs/create_docs branch March 13, 2026 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant