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

Add related examples to docs and website #1075

Open
5 tasks
joshka opened this issue Apr 28, 2024 · 3 comments
Open
5 tasks

Add related examples to docs and website #1075

joshka opened this issue Apr 28, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@joshka
Copy link
Member

joshka commented Apr 28, 2024

Problem

There have been a few questions recently about layout related things in discord. Many of the questions can be answered easily by looking at one of the examples. We don't yet have VHS tapes / gifs of these linked in the README, and they're not linked in the docs / website.

Solution

  • Create any missing VHS tapes for each example - https://github.com/ratatui-org/ratatui/tree/main/examples/vhs
  • Create / update any out of date gifs and upload to the images branch
  • Add the example to the examples README
  • Link to the example from each relevant main widget / layout doc comment
  • Link to the examples from each relevant concept page in the website
@joshka joshka added the enhancement New feature or request label Apr 28, 2024
@kdheepak
Copy link
Collaborator

In addition, I think layouts that are very common could use copy paste friendly docs on the website.

@kdheepak
Copy link
Collaborator

Related: #845, #1014

@joshka
Copy link
Member Author

joshka commented Apr 28, 2024

Related: #845, #1014

Ha, thanks past Joshka. :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants