Skip to content

Update index.rst: Readable screenshot, move down GH reference #467

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
May 19, 2025
Merged

Update index.rst: Readable screenshot, move down GH reference #467

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4f9aeef
Update index.rst
bmunkholm May 13, 2025
b3ecfe3
Add line break between images
bmunkholm May 13, 2025
dfcaa62
Update index.rst with a readable screenshot, moving down GH ref
bmunkholm May 16, 2025
532be6f
Update index.rst
bmunkholm May 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,11 @@
The CrateDB Shell
=================

The CrateDB Shell (aka *Crash*) is an interactive `command-line interface`_
(CLI) tool for working with CrateDB.
The CrateDB Shell (aka *Crash*) is an interactive `CLI`_ for working with CrateDB.

.. SEEALSO::

Crash is an open source project and is `hosted on GitHub`_.

.. sidebar:: Screenshots

.. image:: startup.png
:alt: A screenshot of Crash after startup

.. image:: autocomplete.png
:alt: A screenshot of Crash while typing a query
.. image:: query.png
:alt: A screenshot of Crash after executing a query

.. image:: query.png
:alt: A screenshot of Crash after executing a query

.. rubric:: Table of contents

Expand All @@ -33,5 +21,10 @@ The CrateDB Shell (aka *Crash*) is an interactive `command-line interface`_
troubleshooting
appendices/index

.. _command-line interface: https://en.wikipedia.org/wiki/Command-line_interface
.. SEEALSO::

Crash is an open source project and is `hosted on GitHub`_.


.. _CLI: https://en.wikipedia.org/wiki/Command-line_interface
.. _hosted on GitHub: https://github.com/crate/crash