search

Pirate-Weather / pirateweather

Code and documentation for the Pirate Weather API
Apache License 2.0
617 stars 27 forks source link

Update the docs for V2 Changes #220

Closed cloneofghosts closed 1 month ago

cloneofghosts commented 1 month ago

Update the docs to be fully updated for V2 and finish HA documentation

alexander0042 commented 1 month ago

Great, just pushed another set of additions to the V2.0 docs branch, which should round out all those updates.

One thing I was thinking about was what sort of stuff should go in the HA docs that isn't already included? I added some stuff on alerts, but are there more FAQ's that should be added? Or something more fundamental?

cloneofghosts commented 1 month ago

Was looking through the changes and I don't see anything specific in the HA docs about the alerts sensor. Maybe I missed it but it looks like it's not there? For the HA docs I'd include a link to the data points section in the API documentation. I would document any specific HA things in there that don't apply to the regular API. Be it as FAQs or just regular documentation.

The only other changes needed are the recent updates section on the homepage and the OpenAPI specification as it looks like they were missed.

For the roadmap should RRFS and 3DRTMA be added to the sources list? They're not available yet but should hopefully be released this year. Both will cover all of North America and have a subhourly version.

cloneofghosts commented 1 month ago

Also as per this comment maybe you should clarify where the storm distance is measured from?

alexander0042 commented 1 month ago

Incredible notes, these are great! I'll go through them and double check each one.

Also, note for myself- smoke is ins kg/m3 (the model default), but ug/m3 makes way more sense. Need the docs to report ug/m3 and multiply the response by 10^9

cloneofghosts commented 1 month ago

I fixed the missed spelling change and I updated a few items in the table that I'm sure of but you should double check and make sure.

EDIT: Oh and 2.0.5 will also need to be added to the changelog whenever it gets launched.

alexander0042 commented 1 month ago

Like I said earlier, amazing edits!!! I went through and put them all in, as well as updating the data pipeline page with the new times. I'm going to supersede that page with the details on the new V2 processing flow, but since that's just for general interest I want to get this out first.

Also added some more details on the storm distance, and updated the changelog/ roadmap.

Also really good comment on the OpenAPI specs. Apiable really likes having those, and it's good practice, so I'll add those in before we push this.

cloneofghosts commented 1 month ago

Just took a look through and everything looks good. I think this is everything left before we can merge this in

cloneofghosts commented 1 month ago

@alexander0042 I've updated the OpenAPI spec if you want to double check and make sure everything is good there. I also added in the new sensors into the HA docs page. Is there anything from my last comment that you want to add or is it good to merge?

cloneofghosts commented 1 month ago

I added the new sensors which I added yesterday and the template from the templating issue in HA. @alexander0042 I think things are good now if you could review so we can get this merged in.

alexander0042 commented 1 month ago

Ok, with that fire out I finally had a chance to review this! Read through it all and it's looking good, so I'm going to push to main and see how everything formats

cloneofghosts commented 1 month ago

Was just about to go and fix the changelog version but you beat me to it and added 2.0.6 and 2.0.7. The OpenAPI spec will need to have the versions changed but that's pretty minor.