koalazub/docs.surrealdb.com

The documentation for SurrealDB, powered by Astro

is the ultimate cloud
database for tomorrow's applications

Develop easier.   Build faster.   Scale quicker.

The documentation for SurrealDB, built using Astro.

If you want to contribute, then please read the contributing guidelines.

       

             

Getting started with SurrealDB

Visit surrealdb.com/docs to get started with SurrealDB.

Learn SurrealDB

• SurrealDB University: https://surrealdb.com/learn/fundamentals
• Aeon's Surreal Renaissance (Interative book): https://surrealdb.com/learn/book
• Documentation: https://surrealdb.com/docs

Contributing to the documentation

Please see our contributing guidelines.

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Installation

To get started with contributing to the SurrealDB documentation, first install the required packages using the following command.

This project uses Bun as our package manager. If you haven't installed Bun yet, then please see the installation guide for your operating system. It also requires Node.js v20.0.0 or higher.

bun i 

Development

The following command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

bun dev

Building

The following command builds and generates static content into the build directory, and can then be served using any static contents hosting service.

bun run build

File structure

To contribute to the documentation, most of your changes will be made to the src/content directory. Each section of the documentation has its own subdirectory, and each page is an MDX file.

src/
    assets/
    components/
    content/
        doc-surrealdb/
        doc-surrealql/
        doc-surrealist/
        ...
    layouts/
    pages/
    styles/
    util/ 

Linting

To ensure the documentation is consistent and follows our style guide, we use make qc to check for linting errors. You can also use make qa to automatically fix most of the errors.

Here are the commands for some of the common commands you may need to use.

• make install - Install dependencies, first time or when they change
• make dev - Run a development server
• make build - Build the website
• make preview - Preview a build you made
• make qc - Check code quality (fmt + lint)
• make qa - Apply safe code quality suggestions
• make qau - Apply (un)safe code quality suggestions