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

Initial widget docs #2333

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Conversation

Surendrajat
Copy link
Member

@Surendrajat Surendrajat commented Jul 26, 2020

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

@karliss
Copy link
Member

karliss commented Jul 26, 2020

Please don't merge until the discussion about where to store this is resolved.

@karliss
Copy link
Member

karliss commented Jul 26, 2020

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.

@Surendrajat
Copy link
Member Author

@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.

@ITAYC0HEN ITAYC0HEN added the Question A question about the project, future development, ... label Jul 26, 2020
@ITAYC0HEN
Copy link
Member

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
Graph,
Disassembly
Hexdump

No gifs
Dashboard
Strings
Search

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.
When each widget get their own page, I can see how some of the explanations can be joined with a gifs. For example, in the Strings widget page you can imagine a subtitle "Find references to the string" which will havea gif to show Right Click -> Show x-refs and the menu that will be opened.

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)

@ITAYC0HEN
Copy link
Member

ITAYC0HEN commented Jul 29, 2020

What is the plan then ? :)

@Surendrajat
Copy link
Member Author

@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).

@ITAYC0HEN
Copy link
Member

Catch me next week and I will be able to record some gifs and take screenshots

@Surendrajat
Copy link
Member Author

Surendrajat commented Aug 1, 2020

@ITAYC0HEN

@ITAYC0HEN
Copy link
Member

What, next week arrived so fast? :O

@ITAYC0HEN
Copy link
Member

Updated the dashboard image and other minor fixes. The graph hex and disas can stay gifs.

The UI on my PC for the tree widgets (search, strings, ...) isn't look good as the table look inactive. Please take the screenshots from your machine as it looks better 👍

image

Copy link
Member

@ITAYC0HEN ITAYC0HEN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work 👍

@Surendrajat
Copy link
Member Author

Surendrajat commented Aug 9, 2020

@ITAYC0HEN what you think of the header Widgets? Just thought of changing it to Views as it's in user docs. Also, we can accommodate views like Load Options in here, which are important part of docs but I not sure if they are widgets(?)

@ITAYC0HEN ITAYC0HEN requested a review from karliss August 9, 2020 14:32
@ITAYC0HEN
Copy link
Member

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

@ITAYC0HEN
Copy link
Member

Hey! :)
So the status is that we're waiting for @karliss to move the docs? or for you to write verbose descriptions?

@Surendrajat
Copy link
Member Author

@ITAYC0HEN Both. The description I should do this weekend. The docs moving process will take a while, I assume.

@karliss
Copy link
Member

karliss commented Aug 20, 2020

@Surendrajat

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

@Surendrajat Surendrajat deleted the docs-widget-intro branch December 14, 2020 15:40
@Surendrajat Surendrajat restored the docs-widget-intro branch December 14, 2020 15:40
@Surendrajat Surendrajat reopened this Dec 14, 2020
@thestr4ng3r thestr4ng3r changed the base branch from master to dev December 21, 2021 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Question A question about the project, future development, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants