Skip to content

docs: enhance project documentation#21

Open
mgazz wants to merge 1 commit intoCoHDI:mainfrom
mgazz:docs
Open

docs: enhance project documentation#21
mgazz wants to merge 1 commit intoCoHDI:mainfrom
mgazz:docs

Conversation

@mgazz
Copy link
Collaborator

@mgazz mgazz commented Mar 12, 2026

This PR:

  • improves the README.md
  • adds references to the CoHDI code of conduct and security
  • describes steps to contribute to the project

Signed-off-by: Michele Gazzetti <michele.gazzetti1@ibm.com>
@mgazz mgazz requested review from hase1128 and motooka79 March 12, 2026 09:23
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/12016/badge)](https://www.bestpractices.dev/projects/12016)

// TODO(user): Add simple overview of use/purpose
A Kubernetes operator that dynamically attaches and detaches composable hardware resources—such as GPUs and CXL memory—to cluster nodes using the CDI (Composable Device Infrastructure) API.
Copy link
Collaborator

Choose a reason for hiding this comment

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

memory-to is typo?
How about stating that CXL memory support is planned for the future?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point.

| Type | Description |
|------|-------------|
| `gpu` | NVIDIA GPU cards exposed via the CDI composable fabric |
| `cxl` | CXL-attached memory modules |
Copy link
Collaborator

Choose a reason for hiding this comment

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

We will support CXL memory in the future. (not now)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I will update accordingly

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.

3 participants