Road to v1.0.0

[Korijn]

Meta-issue to list the issues we consider necessary to reach the v1.0.0 milestone.

Must have

Aside of core features, must-haves should be mostly API impacting, stability related issues.

• #20, #271
• #350
• #138
• #321
• #40
• #322
• #272
• #19
• #492
• #556
• https://github.com/pygfx/wgpu-py/issues/391

Nice to have

Can be done later, but would significantly improve user experience.

• #164
• #113, #114, #345, #423

API decision required (no implementation needed)

• #495
• #72
• #197
• #332
• #118
• #320

Important features postponed for implementation after 1.0.0

• #48
• #49
• #391

[FirefoxMetzger]

@Korijn Since this is a central meta-issue, could you pin it so it's easier to find?

Edit: nvm. I have the power to pin. Feel free to unpin if you think this is a bad idea.

[Korijn]

This is the first time I've seen a pinned issue on Github. :) No problem.

[FirefoxMetzger]

@Korijn fyi, the button for it lives here

[Korijn]

After seeing #545 as the latest example I expect more users will be confused by the readme changing on the main branch (which is totally natural) and going out of sync with the last released version of pygfx on pypi.

We can consider using a dev branch to do all our work in between releases, so that the main branch is always in sync with the last released version on pypi. That way we can avoid the confusion.

Or, we drop the installation instructions from the readme and refer to the docs for the latest stable release instead. Essentially that creates a strict separation between readme and docs; one is for contributors, the other is for users.

It's a little silly but it will avoid many future issues I think.

[almarklein]

Another suggestion:

• Change RTD default branch to stable instead of latest.
• Change any links (in the docs and readme) accordingly.
• Add a clear warning to the docs that we're 0.x, so that the API breaks sometimes, and that the example in the readme may require main to work.
• Release more often :)