docs.surrealdb.com

é a nuvem final
Banco de dados para aplicativos de amanhã

Desenvolver mais fácil. Construir mais rápido. Escala mais rápida.

A documentação para SurrealDB, construída usando Astro.

Se você deseja contribuir, leia as diretrizes contribuintes.

Introdução com surrealdb

Visite surrealdb.com/docs para começar com o surrealdb.

Aprenda surrealdb

• Universidade Surrealdb: https://surrealdb.com/learn/fundamentals
• Renascença surreal de Aeon (livro interativo): https://surrealdb.com/learn/book
• Documentação: https://surrealdb.com/docs

Contribuindo para a documentação

Por favor, consulte nossas diretrizes contribuintes.

Boas primeiras questões

Temos uma lista de bons primeiros problemas que contêm bugs que têm um escopo relativamente limitado. Este é um ótimo lugar para começar, ganhar experiência e familiarizar -se com nosso processo de contribuição.

Instalação

Para começar a contribuir para a documentação SurrealDB, primeiro instale os pacotes necessários usando o seguinte comando.

Este projeto usa o BUN como nosso gerenciador de pacotes. Se você ainda não instalou o BUN, consulte o guia de instalação para o seu sistema operacional. Também requer node.js v20.0.0 ou superior.

bun i 

Desenvolvimento

O comando a seguir inicia um servidor de desenvolvimento local e abre uma janela do navegador. A maioria das alterações é refletida ao vivo sem precisar reiniciar o servidor.

 bun dev

Prédio

O comando a seguir cria e gera conteúdo estático no diretório build e pode ser servido usando qualquer serviço de hospedagem de conteúdo estático.

 bun run build

Estrutura de arquivo

Para contribuir com a documentação, a maioria das suas alterações será feita no diretório src/content . Cada seção da documentação possui seu próprio subdiretório e cada página é um arquivo MDX.

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

LING

Para garantir que a documentação seja consistente e siga nosso guia de estilo, usamos make qc para verificar se há erros de linha. Você também pode usar make qa para corrigir automaticamente a maioria dos erros.

Aqui estão os comandos de alguns dos comandos comuns que você pode precisar usar.

• make install - instalar dependências, primeira vez ou quando eles mudarem
• make dev - execute um servidor de desenvolvimento
• make build - Construa o site
• make preview - Visualize uma construção que você fez
• make qc - Verifique a qualidade do código (fmt + fiapos)
• make qa - Aplicar sugestões de qualidade de código seguro
• make qau - aplicar (un) sugestões de qualidade de código seguro