docs: update documentation for the version of the builders

aica-technology / api

AICA API resources

0 stars 0 forks source link

docs: update documentation for the version of the builders #155

Closed LouisBrunner closed 1 month ago

LouisBrunner commented 5 months ago

Description

Update all documentation referring to the old syntax of the builders
Add a page to help migrate from the old version of package-builder (I didn't add one for app-builder because the changes are so small)
Added more in-depth section about version constraints

Review guidelines

Estimated Time of Review: 5 minutes

Checklist before merging:

[N/A] Confirm that the relevant changelog(s) are up-to-date in case of any user-facing changes

domire8 commented 4 months ago

Looking good yeah, thanks for this. This should probably not be merged yet though right, or should this already be live?

LouisBrunner commented 4 months ago

Looking good yeah, thanks for this. This should probably not be merged yet though right, or should this already be live?

With the latest few merges, package-builder:v1 and app-builder:v2 are now live. But we are still missing a lot of pieces, CL, modulo, base, all components/collections. So probably should wait a bit as you said.

domire8 commented 4 months ago

However I think we can do a pretty quick job of updating those now that the underlying dependencies are there.

Do you mean that we make new patch releases for all components with the v2 of package builder?

eeberhard commented 3 months ago

However I think we can do a pretty quick job of updating those now that the underlying dependencies are there.

Do you mean that we make new patch releases for all components with the v2 of package builder?

Yes, many little patch release to upgrade all components and hardware collections to v1 of the package builder. This would be a nice way to explicitly capture the current iron dependency before the next breaking change.