This is the remaining tasks to get the docs to a "complete" state for launch.

User Guides

• Vulnerability Database User Guide

  • File: content/docs/userguides/vuln/database.md
  • Create comprehensive content for the Vulnerability Database user guide section
    • Explain what the vulnerability database is
    • Document how the database is structured
    • Explain update mechanisms
    • Document database schema/format
    • Include troubleshooting tips

• License Scanning

  • Needs more use cases / examples

Contributing Section

Should consider things like:

• Development setup instructions
• Build and test procedures
• PR submission guidelines
• Testing the action locally

Items:

• SBOM-Action Contribution Guide (content/docs/contributing/sbom-action/_index.md)
• Scan-Action Contribution Guide (content/docs/contributing/scan-action/_index.md)
• Grype-DB (content/docs/contributing/grype-db/_index.md)
• Vunnel (content/docs/contributing/vunnel/_index.md)

Reference Section

Note: all of these should be autogenerated

Required:

• Grant config/CLI docs (this will be easier if grant has a container image)

Optional:

• Grype-DB config/CLI docs (this might get moved into grype, so we could wait)
• Vunnel config/CLI docs

Architecture & Concepts

• Architecture Overview
  • File: New - content/docs/concepts/architecture.md or similar
  • High-level architecture documentation
    • Data flow diagram: vunnel → grype-db → grype ← syft
    • Component relationships
    • How the tools work together
    • System requirements
    • Performance considerations
  • Questions:
    • Where should this live? Under "About", "Concepts", or "Overview"?
    • Should this be visual-first with diagrams?

Misc

• Migrate OSS docs style guide to contributing section

Automation

Generate Content:

• CLI Reference
• Config Reference
• Promotions
• Release Notes

After launch

Automation

Orchestrate content generation:

• Event driven post-release process for each cli/config reference section

Consider:

• Extracting output examples and code examples to their own files to test and generate automatically

Content

• About page
• Tutorials