Update docs

rizinorg · Aug 8, 2020 · 3ceaebe · 3ceaebe
1 parent 785d8e6
commit 3ceaebe
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 9 deletions.
diff --git a/docs/source/images/widgets/dashboard.png b/docs/source/images/widgets/dashboard.png
diff --git a/docs/source/images/disassembly.gif → docs/source/images/widgets/disassembly.gif b/docs/source/images/disassembly.gif → docs/source/images/widgets/disassembly.gif
diff --git a/docs/source/images/graph.gif → docs/source/images/widgets/graph.gif b/docs/source/images/graph.gif → docs/source/images/widgets/graph.gif
diff --git a/docs/source/images/hexdump.gif → docs/source/images/widgets/hexdump.gif b/docs/source/images/hexdump.gif → docs/source/images/widgets/hexdump.gif
diff --git a/docs/source/images/search.gif → docs/source/images/widgets/search.gif b/docs/source/images/search.gif → docs/source/images/widgets/search.gif
diff --git a/docs/source/images/strings.gif → docs/source/images/widgets/strings.gif b/docs/source/images/strings.gif → docs/source/images/widgets/strings.gif
diff --git a/docs/source/user-docs.rst b/docs/source/user-docs.rst
@@ -13,6 +13,7 @@ The documentation for users is still on its early stages and will be improved ov
    :titlesonly:
    :glob:
 
+   user-docs/widgets
    user-docs/shortcuts
    user-docs/command-line
    user-docs/menus

diff --git a/docs/source/user-docs/widgets.rst b/docs/source/user-docs/widgets.rst
@@ -1,37 +1,40 @@
 Widgets
 =======
 
-Cutter UI consists of several widgets(views) such as: Disassembly, Decompiler, etc.
-which provide their own functionality, context menus and synchronisation with
+Cutter UI consists of several widgets (views) such as Disassembly, Decompiler, and Hexdump.
+These widgets provide their own functionality, context menus and synchronization with
 other widgets to help user get all sort of analysis done conveniently and quickly.
-Following is a quick overview of these widgets.
 
+These are some of the widgets you can find in Cutter:
+
+
+
 Dashboard Widget
 ------------------
 
-.. image:: ../images/dashboard.gif
+.. image:: ../images/widgets/dashboard.png
 
 Disassembly Widget
 ------------------
 
-.. image:: ../images/disassembly.gif
+.. image:: ../images/widgets/disassembly.gif
 
 Graph Widget
 ------------------
 
-.. image:: ../images/graph.gif
+.. image:: ../images/widgets/graph.gif
 
 HexDump Widget
 ------------------
 
-.. image:: ../images/hexdump.gif
+.. image:: ../images/widgets/hexdump.gif
 
 Search Widget
 ------------------
 
-.. image:: ../images/search.gif
+.. image:: ../images/widgets/search.gif
 
 Strings Widget
 ------------------
 
-.. image:: ../images/strings.gif
+.. image:: ../images/widgets/strings.gif