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

[REQUEST] Could you please add images to the rich docs? #3547

Closed
misrasaurabh1 opened this issue Nov 1, 2024 · 5 comments
Closed

[REQUEST] Could you please add images to the rich docs? #3547

misrasaurabh1 opened this issue Nov 1, 2024 · 5 comments

Comments

@misrasaurabh1
Copy link

How would you improve Rich?

I am a new user to rich. I am a fan, it has improved codeflash.ai 's look and feel quite a lot.

One problem I have is that from the official docs, i don't really understand what a particular feature will do just from looking at the docs. Since rich is such a visual library, adding images to all the examples will greatly help developers understand and value rich.

What problem does it solve for you?

I don't understand what feature could be useful to me, because i don't know what the feature looks like. It limits new user and existing user adoption.

Copy link

github-actions bot commented Nov 1, 2024

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

@willmcgugan
Copy link
Collaborator

What would you like to see images of?

@misrasaurabh1
Copy link
Author

misrasaurabh1 commented Nov 1, 2024

What would you like to see images of?

I would like to see "if i implemented the code example mentioned in the docs, then how would the resulting output look like.".
Without this context I have a hard time understanding what a particular feature means in the doc.

@willmcgugan
Copy link
Collaborator

willmcgugan commented Nov 2, 2024

There are numerous examples of output in the docs, as html. I'm sure there could be more, but frankly you can see the output of most things by copying a few lines in to your terminal.

If you would like to PR for screenshots in the docs, feel free, but this is very low priority considering you are the first to ask.

@willmcgugan willmcgugan closed this as not planned Won't fix, can't repro, duplicate, stale Nov 2, 2024
Copy link

github-actions bot commented Nov 2, 2024

I hope we solved your problem.

If you like using Rich, you might also enjoy Textual

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

No branches or pull requests

2 participants