Skip to content

docs(keycardai): reconcile Python version and add compatibility documentation#62

Open
Larry-Osakwe wants to merge 1 commit intomainfrom
larry/dependency-constraints-docs
Open

docs(keycardai): reconcile Python version and add compatibility documentation#62
Larry-Osakwe wants to merge 1 commit intomainfrom
larry/dependency-constraints-docs

Conversation

@Larry-Osakwe
Copy link
Contributor

Summary

  • Fix Python version in READMEs (3.9 to 3.10) to match pyproject.toml
  • Add Requirements section to agents README (was missing)
  • Add Known Limitations and Non-Goals section to root README
  • Add Compatibility Matrix section with Python versions and dependency rationale
  • Add Versioning and Breaking Changes section documenting alpha status and policies

Test plan

  • Verify Python version is consistent across all READMEs and pyproject.toml files
  • Verify all markdown renders correctly on GitHub
  • Verify links work correctly

…entation

- Fix Python version in READMEs (3.9 -> 3.10) to match pyproject.toml
- Add Requirements section to agents README
- Add Known Limitations & Non-Goals section
- Add Compatibility Matrix with dependency rationale
- Add Versioning & Breaking Changes section

### Non-Goals

- **Standalone Identity Provider**: Keycard SDKs are designed to integrate with Keycard's hosted identity service, not to provide standalone identity management.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't quite know what we mean by standalone identity provider here. Do you mean integrate directly with third-party providers?


### Breaking Change Policy

1. **Breaking changes** are documented in CHANGELOG.md with migration guides
Copy link
Collaborator

Choose a reason for hiding this comment

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

Its alpha I would just say expect breaking changes.

- **MINOR** bumps (`0.x.0`) may contain breaking changes
- **PATCH** bumps (`0.x.y`) are backward-compatible bug fixes

### Alpha Status (`0.x.y`)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I like this, nice.

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