Skip to content

docs: correct README schema diagram and fill in requirements#26

Open
dreadn0ught wants to merge 1 commit into
mainfrom
claude/docs-review-updates-ktscck
Open

docs: correct README schema diagram and fill in requirements#26
dreadn0ught wants to merge 1 commit into
mainfrom
claude/docs-review-updates-ktscck

Conversation

@dreadn0ught

Copy link
Copy Markdown
Contributor

Docs audit against the model code:

  • Mermaid class diagram synced with the actual models — creators: List[str] (was string creator), format (was bomFormat), Component source/env are sets with the missing fields added (namespace, location, metadata, qualifiers, subpath), Environment gains optional project/path, Vulnerability gains the required id field and PackageURL typing.
  • Empty Requirements section filled in from pyproject.toml (Python 3.12+, cyclonedx-python-lib, packageurl-python).
  • Intro now mentions MiniBOM conversion, which the converters implement alongside dict and CycloneDX.

🤖 Generated with Claude Code

https://claude.ai/code/session_012Ewgxf8LXK3E9DYRvmaozk


Generated by Claude Code

Update the OSSBOM class diagram to match the current model code
(creators list, format field, Environment project/path fields,
Component namespace/location/metadata/qualifiers/subpath fields,
Vulnerability id field and defaults), mention MiniBOM conversion,
and list the Python/dependency requirements from pyproject.toml.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012Ewgxf8LXK3E9DYRvmaozk
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.

2 participants