Skip to content

Commit

Permalink
+images
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhghomon committed Jan 11, 2024
1 parent 56816d9 commit 48b75d3
Show file tree
Hide file tree
Showing 14 changed files with 27 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/ui/client_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Client settings
===============

.. image:: images/client_settings.png
:alt: Todo
:width: 100%

The UI exposes a number of :ref:`configuration parameters <ref_std_cfg>`
in a dropdown bar at the top of all database dashboard screens when the
Client Settings button is clicked. They can be modified by double
Expand Down
4 changes: 4 additions & 0 deletions docs/ui/data_explorer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Data Explorer
=============

.. image:: images/data_explorer.png
:alt: Todo
:width: 100%

The data explorer is similar to the UI editor in facilitating queries on
database objects, but involves no direct query building. Instead, the
data explorer gives point-and-click access to the database's objects,
Expand Down
4 changes: 4 additions & 0 deletions docs/ui/database_dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Dashboard
=========

.. image:: images/database_dashboard.png
:alt: Todo
:width: 100%

The dashboard for each database displays the number of object types and
total number of objects contained within.

Expand Down
4 changes: 3 additions & 1 deletion docs/ui/editor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Editor
======

The Editor tab inside the EdgeDB UI
.. image:: images/editor.png
:alt: Todo
:width: 100%

Query Editor
------------
Expand Down
Binary file added docs/ui/images/client_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/data_explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/database_dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/schema_viewer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/ui_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/ui/images/ui_repl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/ui/schema_viewer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Schema Viewer
=============

.. image:: images/schema_viewer.png
:alt: Todo
:width: 100%

The UI schema viewer allows you to see your schema either as text, graph,
or both.

Expand Down
4 changes: 4 additions & 0 deletions docs/ui/ui_home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
UI Home
=======

.. image:: images/ui_home.png
:alt: Todo
:width: 100%

The UI homepage displays one button per database inside the instance.
New instances will contain a database called ``edgedb`` by default.

Expand Down
4 changes: 4 additions & 0 deletions docs/ui/ui_repl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
REPL
====

.. image:: images/ui_repl.png
:alt: Todo
:width: 100%

The REPL used in the EdgeDB UI is largely the same as the CLI REPL,
so most of the commands :ref:`here <ref_cheatsheet_repl>` will pertain to the
UI REPL as well.
Expand Down

0 comments on commit 48b75d3

Please sign in to comment.