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

It would be awesome to have screenshots in docs #907

Open
iosifnicolae2 opened this issue Dec 18, 2024 · 2 comments
Open

It would be awesome to have screenshots in docs #907

iosifnicolae2 opened this issue Dec 18, 2024 · 2 comments

Comments

@iosifnicolae2
Copy link

Hi,

I like the new documentation pages, but I wish there were screenshots on each page. This would make it much easier for users to understand what they will get by following the instructions.

Thank you very much!

@lukasvinclav
Copy link
Contributor

Actually this is something what I was already considering but the problem is with the amount of resources (my time) which will such a small thing require. I did a quick math and it would require uploading around 40 screenshots which will already take a lot of time. The hardest part would be keeping the screenshot in sync with the current design. Each time design is changed, I have to reupload screenshots reflecting new changes.

To solve this problem, I decided in the past to create a public demo repository where you can see all the combinations which Unfold provides. I understand this is not optimal solution but I want to focus on shipping new things for now.

@iosifnicolae2
Copy link
Author

An alternative would be to create a page for each functionality on the demo instance and add a link to that website.

But having a screenshot is extremely valuable in my opinion, even though might not be up to date all the time.. the idea is to help developers understand easier what they will get if they use that Unfold feature..

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

No branches or pull requests

2 participants