docs.surrealdb.com

est le nuage ultime
base de données pour les applications de demain

Se développer plus facilement. Construire plus vite. Évoluer plus rapidement.

La documentation de SurrealDB, construite à l'aide d'Astro.

Si vous souhaitez contribuer, veuillez lire les directives contributives.

Début avec Surrealdb

Visitez surréaldb.com/docs pour commencer avec SurrealDB.

Apprenez surréaldb

• Université Surrealdb: https://surrealdb.com/learn/fundamentals
• Aeon's Surreal Renaissance (livre interative): https://surrealdb.com/learn/book
• Documentation: https://surrealdb.com/docs

Contribuant à la documentation

Veuillez consulter nos directives contributives.

Bons premiers problèmes

Nous avons une liste de bons premiers problèmes qui contiennent des bogues qui ont une portée relativement limitée. C'est un endroit idéal pour commencer, acquérir de l'expérience et se familiariser avec notre processus de contribution.

Installation

Pour commencer par la contribution à la documentation SurrealDB, installez d'abord les packages requis à l'aide de la commande suivante.

Ce projet utilise BUN comme gestionnaire de packages. Si vous n'avez pas encore installé BUN, veuillez consulter le guide d'installation de votre système d'exploitation. Il nécessite également Node.js v20.0.0 ou plus.

bun i 

Développement

La commande suivante démarre un serveur de développement local et ouvre une fenêtre de navigateur. La plupart des modifications sont reflétées en direct sans avoir à redémarrer le serveur.

 bun dev

Bâtiment

La commande suivante construit et génère du contenu statique dans le répertoire build , puis peut être servi à l'aide de tout service d'hébergement de contenu statique.

 bun run build

Structure de fichiers

Pour contribuer à la documentation, la plupart de vos modifications seront apportées au répertoire src/content . Chaque section de la documentation a son propre sous-répertoire, et chaque page est un fichier MDX.

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

Libellé

Pour s'assurer que la documentation est cohérente et suit notre guide de style, nous utilisons make qc pour vérifier les erreurs de liaison. Vous pouvez également utiliser make qa pour corriger automatiquement la plupart des erreurs.

Voici les commandes de certaines des commandes communes que vous devrez peut-être utiliser.

• make install - Installer les dépendances, la première fois ou quand ils changent
• make dev - Exécuter un serveur de développement
• make build - construire le site Web
• make preview - Aperçu une version que vous avez faite
• make qc - Vérifier la qualité du code (FMT + Lint)
• make qa - Appliquer des suggestions de qualité de code sûr
• make qau - Appliquer (non) des suggestions de qualité de code sûr