Stream: platform development

Topic: releases, docs and examples

Luke Boswell (Jan 08 2025 at 10:24):

I know this is probably a bit of a nit... but while I'm looking at it in the basic-cli README I thought I might ask the question. Should the following be inverted; from this.

👀 examples:

- 0.18.0
- 0.17.0
- 0.16.0
- latest main branch

📖 documentation:

- 0.18.0
- 0.17.0

To more like this?

- 0.18.0: 👀 examples, 📖 documentation
- 0.17.0: 👀 examples, 📖 documentation
- 0.16.0: 👀 examples, 📖 documentation

My logic is that if you are looking for the 0.18.0 docs or examples then you would expect them together.

My other thought, was would it be better to link the versioned examples and documentation in the specific GH Releases; and only have the latest release e.g. 0.18.0 in the README?

Sam Mohr (Jan 08 2025 at 10:27):

That all looks good to me.

Sam Mohr (Jan 08 2025 at 10:28):

But you'll need to upload 0.16.0 if you want exactly this to work

Sam Mohr (Jan 08 2025 at 10:28):

I assume it's just an example

Luke Boswell (Jan 08 2025 at 10:31):

It's easy enough to add 0.16.0

Anton (Jan 08 2025 at 10:35):

only have the latest release e.g. 0.18.0 in the README?

It would make those links a lot harder to find for those unfamiliar with github releases

Anton (Jan 08 2025 at 10:36):

To more like this?

The repeated icons look a bit weird but having the two side-by-side is ok, not sure it really matters

Last updated: Jul 05 2025 at 12:14 UTC