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

docs: update assets #2436

Closed
wants to merge 16 commits into from
Closed

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Jun 25, 2024

Description

This PR updates outdated images & gifs in the documentation; each gif can now be generated using the VHS tool - I've written tapes for all gifs that we have. It also updates the folder structure of the assets dir to match the current state of the docs.

Docs preview: https://www.loom.com/share/bc45e56c58a741c8bb2109be8947aa66?sid=5a1b73ff-cc5a-49ef-a4cc-7af01e765181

Further down the line we can see if there is a way to check if gifs are outdated and automatically update them.

Closes: #2392

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

@leohhhn
Copy link
Contributor Author

leohhhn commented Jul 1, 2024

There's an issue with this PR; the size of the gifs & the commits will make the repo size very large. Not sure what the right way to go forward with this is.

One way we can go about this is that we can have a script that will run before deployment on the docs.gno.land repo, which will generate the gifs for the prod version. So, we would only keep the .tape files.

Unrelated but still an issue; gnokey export & gnokey import do not work to be generated with VHS for some reason, regarding the password inputs. Trying to figure out a workaround.

Copy link

This PR is stale because it has been open 3 months with no activity. Remove stale label or comment or this will be closed in 3 months.

@github-actions github-actions bot added the Stale label Nov 10, 2024
@leohhhn
Copy link
Contributor Author

leohhhn commented Nov 10, 2024

Closing as we probably won't be needing this.

@leohhhn leohhhn closed this Nov 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

[docs] Update outdated images & gifs
1 participant