Skip to content

docs: readme instructions updated to reference 1.0.0#162

Merged
frayle-ons merged 3 commits intomainfrom
161-docs-updates-for-version-1
Mar 30, 2026
Merged

docs: readme instructions updated to reference 1.0.0#162
frayle-ons merged 3 commits intomainfrom
161-docs-updates-for-version-1

Conversation

@frayle-ons
Copy link
Copy Markdown
Contributor

✨ Summary

Recent updates to the package took us to version 1.0.0. These changes clean up any documentation that references how to install the package. Specifically updating mentions of version 0.2.1 to

📜 Changes Introduced

  • docs: Updated demos readme to reference install instructions for 1.0.0
  • docs: updated main readme to use 1.0.0 as example for installs

✅ Checklist

  • Code passes linting with Ruff
  • Security checks pass using Bandit
  • API and Unit tests are written and pass using pytest
  • Terraform files (if applicable) follow best practices and have been validated (terraform fmt & terraform validate)
  • DocStrings follow Google-style and are added as per Pylint recommendations
  • Documentation has been updated if needed

🔍 How to Test

Try installing version 1.0.0 of the package and executing some of the notebooks or code snippets

@frayle-ons frayle-ons requested a review from a team as a code owner March 27, 2026 16:48
@frayle-ons frayle-ons linked an issue Mar 27, 2026 that may be closed by this pull request
@frayle-ons frayle-ons changed the title readme instructions updated to reference 1.0.0 docs: readme instructions updated to reference 1.0.0 Mar 27, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Mar 27, 2026
@frayle-ons frayle-ons requested a review from rileyok-ons March 30, 2026 12:50
Copy link
Copy Markdown
Contributor

@rileyok-ons rileyok-ons left a comment

Choose a reason for hiding this comment

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

Looks Great, let's get it fully updated!

@frayle-ons frayle-ons merged commit db41db7 into main Mar 30, 2026
5 checks passed
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs updates for version 1.0.0

2 participants