diff --git a/docs/intro/quickstart/connecting/index.rst b/docs/intro/quickstart/connecting/index.rst new file mode 100644 index 00000000000..18bee065359 --- /dev/null +++ b/docs/intro/quickstart/connecting/index.rst @@ -0,0 +1,11 @@ +.. edb:env-switcher:: + +========== +Connecting +========== + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs diff --git a/docs/intro/quickstart/connecting.rst b/docs/intro/quickstart/connecting/nextjs.rst similarity index 100% rename from docs/intro/quickstart/connecting.rst rename to docs/intro/quickstart/connecting/nextjs.rst diff --git a/docs/intro/quickstart/index.rst b/docs/intro/quickstart/index.rst index a9dd7543131..0bc81d3b904 100644 --- a/docs/intro/quickstart/index.rst +++ b/docs/intro/quickstart/index.rst @@ -1,5 +1,3 @@ -.. _ref_quickstart: - ========== Quickstart ========== @@ -8,55 +6,9 @@ Quickstart :maxdepth: 1 :hidden: - setup - modeling - connecting - working - inheritance - - -Welcome to the quickstart tutorial! In this tutorial, you will update a simple Next.js application to use |Gel| as your data layer. The application will let users build and manage their own study decks, with each flashcard featuring customizable text on both sides - making it perfect for studying, memorization practice, or creating educational games. - -Don't worry if you're new to |Gel| - you will be up and running with a working Next.js application and a local |Gel| database in just about **5 minutes**. From there, you will replace the static mock data with a |Gel| powered data layer in roughly 30-45 minutes. - -By the end of this tutorial, you will be comfortable with: - -* Creating and updating a database schema -* Running migrations to evolve your data -* Writing EdgeQL queries in text and via a TypeScript query builder -* Building an app backed by |Gel| - -Features of the flashcards app ------------------------------- - -* Create, edit, and delete decks -* Add/remove cards with front/back content -* Simple Next.js + Tailwind UI -* Clean, type-safe schema with |Gel| - -Requirements ------------- - -Before you start, you need: - -* Basic familiarity with TypeScript, Next.js, and React -* Node.js 20+ on a Unix-like OS (Linux, macOS, or WSL) -* A code editor you love - -Why |Gel| for Next.js? ----------------------- - -* **Type Safety**: Catch data errors before runtime -* **Rich Modeling**: Use object types and links to model relations -* **Modern Tooling**: TypeScript-friendly schemas and migrations -* **Performance**: Efficient queries for complex data -* **Developer Experience**: An intuitive query language (EdgeQL) - -Need Help? ----------- - -If you run into issues while following this tutorial: - -* Check the `Gel documentation `_ -* Visit our `community Discord `_ -* File an issue on `GitHub `_ + overview/index + setup/index + modeling/index + connecting/index + working/index + inheritance/index \ No newline at end of file diff --git a/docs/intro/quickstart/images/timestamped.png b/docs/intro/quickstart/inheritance/images/timestamped.png similarity index 100% rename from docs/intro/quickstart/images/timestamped.png rename to docs/intro/quickstart/inheritance/images/timestamped.png diff --git a/docs/intro/quickstart/inheritance/index.rst b/docs/intro/quickstart/inheritance/index.rst new file mode 100644 index 00000000000..fa24cf5b8dd --- /dev/null +++ b/docs/intro/quickstart/inheritance/index.rst @@ -0,0 +1,12 @@ +.. edb:env-switcher:: + +=========== +Inheritance +=========== + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs + diff --git a/docs/intro/quickstart/inheritance.rst b/docs/intro/quickstart/inheritance/nextjs.rst similarity index 100% rename from docs/intro/quickstart/inheritance.rst rename to docs/intro/quickstart/inheritance/nextjs.rst diff --git a/docs/intro/quickstart/images/schema-ui.png b/docs/intro/quickstart/modeling/images/schema-ui.png similarity index 100% rename from docs/intro/quickstart/images/schema-ui.png rename to docs/intro/quickstart/modeling/images/schema-ui.png diff --git a/docs/intro/quickstart/modeling/index.rst b/docs/intro/quickstart/modeling/index.rst new file mode 100644 index 00000000000..e1fed28cb1d --- /dev/null +++ b/docs/intro/quickstart/modeling/index.rst @@ -0,0 +1,13 @@ +.. edb:env-switcher:: + +======== +Modeling +======== + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs + + diff --git a/docs/intro/quickstart/modeling.rst b/docs/intro/quickstart/modeling/nextjs.rst similarity index 100% rename from docs/intro/quickstart/modeling.rst rename to docs/intro/quickstart/modeling/nextjs.rst diff --git a/docs/intro/quickstart/overview/index.rst b/docs/intro/quickstart/overview/index.rst new file mode 100644 index 00000000000..bdf8f1e098b --- /dev/null +++ b/docs/intro/quickstart/overview/index.rst @@ -0,0 +1,11 @@ +.. edb:env-switcher:: + +======== +Overview +======== + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs \ No newline at end of file diff --git a/docs/intro/quickstart/overview/nextjs.rst b/docs/intro/quickstart/overview/nextjs.rst new file mode 100644 index 00000000000..ee5550b9481 --- /dev/null +++ b/docs/intro/quickstart/overview/nextjs.rst @@ -0,0 +1,51 @@ +.. _ref_quickstart: + +========== +Quickstart +========== + +Welcome to the quickstart tutorial! In this tutorial, you will update a simple Next.js application to use |Gel| as your data layer. The application will let users build and manage their own study decks, with each flashcard featuring customizable text on both sides - making it perfect for studying, memorization practice, or creating educational games. + +Don't worry if you're new to |Gel| - you will be up and running with a working Next.js application and a local |Gel| database in just about **5 minutes**. From there, you will replace the static mock data with a |Gel| powered data layer in roughly 30-45 minutes. + +By the end of this tutorial, you will be comfortable with: + +* Creating and updating a database schema +* Running migrations to evolve your data +* Writing EdgeQL queries in text and via a TypeScript query builder +* Building an app backed by |Gel| + +Features of the flashcards app +------------------------------ + +* Create, edit, and delete decks +* Add/remove cards with front/back content +* Simple Next.js + Tailwind UI +* Clean, type-safe schema with |Gel| + +Requirements +------------ + +Before you start, you need: + +* Basic familiarity with TypeScript, Next.js, and React +* Node.js 20+ on a Unix-like OS (Linux, macOS, or WSL) +* A code editor you love + +Why |Gel| for Next.js? +---------------------- + +* **Type Safety**: Catch data errors before runtime +* **Rich Modeling**: Use object types and links to model relations +* **Modern Tooling**: TypeScript-friendly schemas and migrations +* **Performance**: Efficient queries for complex data +* **Developer Experience**: An intuitive query language (EdgeQL) + +Need Help? +---------- + +If you run into issues while following this tutorial: + +* Check the `Gel documentation `_ +* Visit our `community Discord `_ +* File an issue on `GitHub `_ diff --git a/docs/intro/quickstart/setup/index.rst b/docs/intro/quickstart/setup/index.rst new file mode 100644 index 00000000000..41f28c1b6d6 --- /dev/null +++ b/docs/intro/quickstart/setup/index.rst @@ -0,0 +1,11 @@ +.. edb:env-switcher:: + +===== +Setup +===== + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs diff --git a/docs/intro/quickstart/setup.rst b/docs/intro/quickstart/setup/nextjs.rst similarity index 100% rename from docs/intro/quickstart/setup.rst rename to docs/intro/quickstart/setup/nextjs.rst diff --git a/docs/intro/quickstart/images/flashcards-import.png b/docs/intro/quickstart/working/images/flashcards-import.png similarity index 100% rename from docs/intro/quickstart/images/flashcards-import.png rename to docs/intro/quickstart/working/images/flashcards-import.png diff --git a/docs/intro/quickstart/working/index.rst b/docs/intro/quickstart/working/index.rst new file mode 100644 index 00000000000..8ab5d52a37a --- /dev/null +++ b/docs/intro/quickstart/working/index.rst @@ -0,0 +1,14 @@ +.. edb:env-switcher:: + +======= +Working +======= + +.. toctree:: + :maxdepth: 3 + :hidden: + + nextjs + + + diff --git a/docs/intro/quickstart/working.rst b/docs/intro/quickstart/working/nextjs.rst similarity index 100% rename from docs/intro/quickstart/working.rst rename to docs/intro/quickstart/working/nextjs.rst