Skip to content

Commit

Permalink
Surrealist documentation fixes (#928)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ekwuno authored Oct 9, 2024
1 parent 5375464 commit 36ae108
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 158 deletions.
21 changes: 21 additions & 0 deletions src/content/doc-surrealist/advanced-topics/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 1
sidebar_label: Advanced topics
title: Surrealist | Advanced topics
description: Surrealist is a user interface for interacting with your SurrealDB database visually. It enables you to seamlessly connect to any SurrealDB instance, allowing you to execute queries, explore your tables, design your schemas, and much more.
no_page_headings: true
---

# Advanced topics

In this section, we will go over additional features that surrealist offers to enhance your workflow.

- [Search and shortcuts](/docs/surrealist/advanced-topics/search-and-shortcuts)
- [Embedding Surrealist](/docs/surrealist/advanced-topics/embedding-surrealist)
- [Connection Templates](/docs/surrealist/advanced-topics/connection-templates)
- [Settings and customisation](/docs/surrealist/advanced-topics/settings-and-customisation)
- [SurrealQL Editors](/docs/surrealist/advanced-topics/surrealql-editors)
- [URL Intents](/docs/surrealist/advanced-topics/intents)



22 changes: 22 additions & 0 deletions src/content/doc-surrealist/concepts/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 1
sidebar_label: Concepts
title: Surrealist | Concepts
description: Surrealist is a user interface for interacting with your SurrealDB database visually. It enables you to seamlessly connect to any SurrealDB instance, allowing you to execute queries, explore your tables, design your schemas, and much more.
no_page_headings: true
---

# Concepts

In this section, we will go over the different views and features available in Surrealist. You will learn how to connect to your database, how to execute queries, how to explore your data, and how to design your schema.

- [Sending queries to the database](/docs/surrealist/concepts/sending-queries)
- [Exploring database records](/docs/surrealist/concepts/explore-database-records)
- [Designing your schema](//docs/surrealist/concepts/designing-the-database-schema)
- [Manage database access](/docs/surrealist/concepts/manage-database-access)
- [Sending queries with GraphQL](/docs/surrealist/concepts/sending-queries-with-graphql)
- [Local database serving](/docs/surrealist/concepts/local-database-serving)
- [Writing stored procedures](/docs/surrealist/concepts/writing-stored-procedures)
- [Specialized API Docs](/docs/surrealist/concepts/specialized-api-docs)


Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: Surrealist is a user interface for interacting with your SurrealDB
import Image from "@components/Image.astro";
import ImageApidocs from "@img/surrealist-api-docs.png";

# Spcialized API docs
# Specialized API docs

SurrealDB supports a wide array of programming languages to integrate with. The Surrealist API Docs view provides you with a detailed and specialized documentation to integrate with your database using your preferred programming language.
The API Docs contains topics such as authentication, schema management, and query execution, all brought in context using your database schema.
Expand Down
6 changes: 0 additions & 6 deletions src/content/doc-surrealist/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,6 @@ If the connection failed and you see a red indicator, make sure all your details

## Navigation

<Image
alt="Sidebar"
style={{ float: 'right', width: 150, marginLeft: 28 }}
src={ImageSidebar}
/>

On the left side of the interface you will find the navigation sidebar. This sidebar allows you to switch between different views in Surrealist. Each view is focused on a specific workflow for working with the database.
If you are just getting started, we recommend one of the following:

Expand Down
5 changes: 3 additions & 2 deletions src/content/doc-surrealist/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ Surrealist is a user interface for interacting with your SurrealDB database visu

Before we dive into the details, let's start by installing Surrealist. The next page will introduce you to the web app and guide you through the installation process for Surrealist Desktop.

<a href="/docs/surrealist/installation">
<button className="feedback-btn" style={{ fontSize: '1rem', marginTop: 0 }}>Installation guide</button>

<a href="/docs/surrealist/installation" style={{ marginTop: '20px', display: 'block' }}>
<button class="bg-transparent cursor-pointer text-[0.8125rem] mt-5 px-3 py-[0.45rem] rounded-2xl border-2 border-solid border-[#ff00A00] hover:border-[$hover-color] hover:text-[$hover-color];" style={{ fontSize: '1rem', marginTop: 0 }}>Installation guide</button>
</a>

## Video guide
Expand Down
4 changes: 2 additions & 2 deletions src/content/doc-surrealist/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ This web app contains most of the features available in the desktop app, but wit
The Surrealist Desktop app is the recommended way to use Surrealist, as it offers more features and flexibility compared to the web app. Some advantages of the desktop app include the ability to connect to insecure endpoints,
directly opening `.surql` files from your file system, and more.

<a href="https://surrealdb.com/surrealist?download" target="_blank">
<button className="feedback-btn" style={{ fontSize: '1rem', marginTop: 0 }}>Download Surrealist Desktop</button>
<a href="https://surrealdb.com/surrealist?download" style={{ marginTop: '20px', display: 'block' }}>
<button class="bg-transparent cursor-pointer text-[0.8125rem] mt-5 px-3 py-[0.45rem] rounded-2xl border-2 border-solid border-[#ff00A00] hover:border-[$hover-color] hover:text-[$hover-color];" style={{ fontSize: '1rem', marginTop: 0 }}>Download Surrealist Desktop</button>
</a>

### Windows
Expand Down
4 changes: 0 additions & 4 deletions src/content/doc-surrealist/tutorials/_category_.json

This file was deleted.

67 changes: 0 additions & 67 deletions src/content/doc-surrealist/tutorials/creating-a-connection.mdx

This file was deleted.

This file was deleted.

19 changes: 0 additions & 19 deletions src/content/doc-surrealist/tutorials/index.mdx

This file was deleted.

0 comments on commit 36ae108

Please sign in to comment.