-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Initial widget docs #2333
base: dev
Are you sure you want to change the base?
Initial widget docs #2333
Conversation
Please don't merge until the discussion about where to store this is resolved. |
In some of the cases I don't think moving gif adds any value for document widgets. It only makes it more difficult to inspect it or read the text as things keep moving and you can't even stop it. An overview video would be nice. It also wouldn't be affected by the size discussion problem since it would probably be stored on a video hosting service like Youtube. |
@karliss agree. Gifs are a bit awkward but this is what I could do until someone does a good intro video. We can keep this open and replace gifs with ss if that's done. |
Ignoring the file sizes and their storage location Conceptually I like gifs, but sometimes it's too much and unnecessary. I second Karliss and say that some widgets doesn't need gifs at the moment. Gifs No gifs Now, in the future I'd like every widget to have its own page. It's not rare that we get questions on our chats asking how to do X and Y while they are hiding in a shortcut, a double click or a right-click. Describing each column, menu item and more is very helpful. That said, gifs are harder to maintain and as changes introduce, gifs quickly become outdated (since they show more views than a regular screenshot, e.g context menus) |
What is the plan then ? :) |
@ITAYC0HEN I can remove gifs but on my small screen, it's hard to take full ss (the reason why Dashboard widget is a gif). Should we open an issue for this? Because it's a good time to have some visuals(moving, preferably). |
Catch me next week and I will be able to record some gifs and take screenshots |
What, next week arrived so fast? :O |
3ceaebe
to
67d21af
Compare
be38a1a
to
85f6190
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work 👍
@ITAYC0HEN what you think of the header |
I don't consider them a widgets, but dialogs. You can keep it as "Widgets". We have dozens of Widgets and views, having them together in one place (like now) is only an initial phase of the docs. At the end they should all have their own detailed page |
Hey! :) |
@ITAYC0HEN Both. The description I should do this weekend. The docs moving process will take a while, I assume. |
It's not looking so bad. I would like to get some feedback on #2399 |
Adds an introduction page for different Cutter widgets in User Docs. I prefer full video introduction for Cutter but until that's done, we can utilize gifs for this.
Your checklist for this pull request
Detailed description
Adding gif images for the widgets with a little summary. As mentioned in #2259 it adds significant bloat to the repo and can be split in a separate repo as discussed in #2056.
Test plan (required)
Build docs and run.
Closing issues