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

Create Examples Gallery + Tests #125

Open
2 of 3 tasks
ecton opened this issue Jan 5, 2024 · 1 comment
Open
2 of 3 tasks

Create Examples Gallery + Tests #125

ecton opened this issue Jan 5, 2024 · 1 comment

Comments

@ecton
Copy link
Member

ecton commented Jan 5, 2024

The examples folder is already huge, as I have taken to the strategy of making a lot of micro-examples to demonstrate each feature. This means, however, that the directory is hard to navigate.

  • Design a process to create recordings of the examples
  • Create a CI job that records the examples and uploads the APNGs to dossier
  • Create a README to live in the examples folder that presents the list of examples with some attempt at organization
ecton added a commit that referenced this issue May 12, 2024
Undocumented and unsupported, but this allows generating example images.

This push is testing that the image makes it through CI.

Refs #125
@ecton
Copy link
Member Author

ecton commented May 12, 2024

I've moved the guide example capture process into cushy as an undocumented feature, and have hooked up the theme editor example to this system. The screenshot is now in the readme as a proof of concept.

Now the rest of the work is staging each of the examples and either creating screenshots or animations depending on what can show off the example the easiest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Future
Development

No branches or pull requests

1 participant