Skip to content

docs: expand quickstart guide and enhance verification script - #107

Merged
Imran Siddique (imran-siddique) merged 1 commit into
mainfrom
docs/enhance-quickstart
Mar 8, 2026
Merged

Imran Siddique (imran-siddique) merged 1 commit into
mainfrom
docs/enhance-quickstart

Conversation

@imran-siddique

Copy link
Copy Markdown
Collaborator

Summary

Expands the quickstart guide and verification script from #106 (our first community contribution by Davide Quarracino (@davidequarracino)) into a comprehensive 10-minute tutorial.

QUICKSTART.md (8 lines -> 120 lines)

  • Full 6-section tutorial: Install, Verify, First Policy, Framework Wrapping, OWASP Check, Integrity
  • Real pip install commands matching our published PyPI packages
  • Working code examples with PolicyEngine and KernelSpace
  • Next steps table linking to all key docs
  • Attribution to the original contributor

scripts/check_gov.py (17 lines -> 85 lines)

  • Checks all 4 core packages + security deps + optional AI/ML deps
  • Verifies governance CLI availability
  • Proper exit codes (0=ready, 1=incomplete) for CI usage
  • Visual formatting with pass/fail indicators

Builds on #106 | Partially addresses #47

Build on @davidequarracino's initial contribution (#106):

QUICKSTART.md:
- Full 10-minute tutorial with 6 sections
- Real installation commands (pip install ai-agent-compliance[full])
- First governed agent example with PolicyEngine
- Framework wrapping example (LangChain)
- OWASP ASI verification and integrity CLI usage
- Next steps table linking to docs, examples, contributing

scripts/check_gov.py:
- Check all 4 core packages (agent-os, agentmesh, compliance, sre)
- Check security dependencies (cryptography, pynacl)
- Check optional AI/ML dependencies (langchain-core, openai)
- Verify governance CLI availability
- Proper exit codes for CI usage
- Visual formatting with pass/fail indicators

Co-authored-by: davidequarracino <257866518+davidequarracino@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@imran-siddique
Imran Siddique (imran-siddique) merged commit 1aabefc into main Mar 8, 2026
24 of 25 checks passed
@github-actions

github-actions Bot commented Mar 8, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@imran-siddique
Imran Siddique (imran-siddique) deleted the docs/enhance-quickstart branch March 8, 2026 20:02
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/L Large PR (< 500 lines) labels Mar 8, 2026
MohammadHaroonAbuomar pushed a commit to MohammadHaroonAbuomar/agt-acs that referenced this pull request Jun 1, 2026
…oft#107)

Build on @davidequarracino's initial contribution (microsoft#106):

QUICKSTART.md:
- Full 10-minute tutorial with 6 sections
- Real installation commands (pip install ai-agent-compliance[full])
- First governed agent example with PolicyEngine
- Framework wrapping example (LangChain)
- OWASP ASI verification and integrity CLI usage
- Next steps table linking to docs, examples, contributing

scripts/check_gov.py:
- Check all 4 core packages (agent-os, agentmesh, compliance, sre)
- Check security dependencies (cryptography, pynacl)
- Check optional AI/ML dependencies (langchain-core, openai)
- Verify governance CLI availability
- Proper exit codes for CI usage
- Visual formatting with pass/fail indicators

Co-authored-by: davidequarracino <257866518+davidequarracino@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/L Large PR (< 500 lines)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant