Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.4.1 docs #374

Merged
merged 6 commits into from
Nov 26, 2024
Merged

2.4.1 docs #374

merged 6 commits into from
Nov 26, 2024

Conversation

cloneofghosts
Copy link
Collaborator

@cloneofghosts cloneofghosts commented Nov 18, 2024

Describe the change

Updates the API docs for version 2.4.

Type of change

  • Updated Home Assistant documentation
  • General documentation updates (fixing typos, updating information, etc.)
  • Added item to who is using section
  • Updated docs for new API version release

Checklist

@cloneofghosts cloneofghosts added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 19, 2024
@alexander0042
Copy link
Collaborator

Thanks again for making this checklist, it makes it so much easier to keep track of things! I'll work away at it and check things off as I go

@cloneofghosts
Copy link
Collaborator Author

Did a few more updates here:

  • Updated README
  • Updated OpenAPI spec
  • Updated recent updates
  • Updated roadmap
  • Remove old processing scripts

You'll want to double check and make sure everything is good before merging this in. I updated the recent updates section with a copy of the changelog but it looks to be slightly outdated. Don't see the alert change in there or if #360 or #369 will be fixed before launch.

@cloneofghosts
Copy link
Collaborator Author

@alexander0042 I saw that in the changelog the release date for V2.4 is supposed to be today. Is that still the plan or do we need to update the launch date in the changelog?

@alexander0042
Copy link
Collaborator

That was the goal, but I really want to get issue #360 integrated, since it's some pretty low hanging fruit. Didn't quite make the Friday deadline, but I should have a chance to put it in this weekend! It'll be a series of np.clip functions, so conceptually pretty simple, but just a lot of code coverage

@alexander0042
Copy link
Collaborator

Also hoping to get Issue #369 in as well! It's a variable swap, so know what needs to be done, and should be really doable

@cloneofghosts
Copy link
Collaborator Author

That was the goal, but I really want to get issue #360 integrated, since it's some pretty low hanging fruit. Didn't quite make the Friday deadline, but I should have a chance to put it in this weekend! It'll be a series of np.clip functions, so conceptually pretty simple, but just a lot of code coverage

Alright sounds good. Will let you update the date/changelog as needed.

@cloneofghosts cloneofghosts changed the title 2.4.0 docs 2.4.1 docs Nov 26, 2024
@cloneofghosts cloneofghosts marked this pull request as ready for review November 26, 2024 18:07
@cloneofghosts
Copy link
Collaborator Author

@alexander0042 Updated the docs for V2.4.1. Is this good to merge in and can we make the code repository public or not yet?

If we can make it public then I'll add a link to the repo when creating a new issue.

@alexander0042
Copy link
Collaborator

Yes on both counts! We're good to merge, and I'll flip the code repo over to public now! I want to more documentation on how to actually run it and finish the repo setup stuff before I blast it out on the e-mail list, but no reason not to soft launch it

@cloneofghosts cloneofghosts merged commit d92d578 into main Nov 26, 2024
2 checks passed
@cloneofghosts cloneofghosts deleted the 2.4.0-docs branch November 26, 2024 21:41
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 enhancement New feature or request
Projects
Status: Done
2 participants