From b963f9dc6e5fc67ded406781c395927a40d58ae8 Mon Sep 17 00:00:00 2001 From: mde-pach <12986913+mde-pach@users.noreply.github.com> Date: Wed, 20 Mar 2024 12:55:06 +0100 Subject: [PATCH] change the /blitz preffix in the documentation (#39) * fix bug (#38) * change the /blitz preffix --------- Co-authored-by: pbrochar <36422268+pbrochar@users.noreply.github.com> --- blitz/cli/commands/clone.py | 2 +- docs/api/index.md | 6 +++--- docs/cli/start.md | 2 +- docs/dashboard/logs.md | 2 +- docs/index.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/blitz/cli/commands/clone.py b/blitz/cli/commands/clone.py index d0e6951..349e904 100644 --- a/blitz/cli/commands/clone.py +++ b/blitz/cli/commands/clone.py @@ -16,7 +16,7 @@ def clone_project( ) -> None: parsed_url = urlparse(url) - if force is False and not parsed_url.path.endswith("blitz-config"): + if force is False and not parsed_url.path.endswith("blitz-file"): print(f"Invalid URL: {url}") raise typer.Exit(1) diff --git a/docs/api/index.md b/docs/api/index.md index 0bf3b51..45c530e 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,8 +1,8 @@ # API -The Blitz API contains all the exposed CRUD operations defined on the [Blitz File](/blitz/blitzfile/), but also the `/blitz-file` which is, as its name suggests, the Json representation of the running Blitz File. +The Blitz API contains all the exposed CRUD operations defined on the [Blitz File](/blitzfile), but also the `/blitz-file` which is, as its name suggests, the Json representation of the running Blitz File. -This feature is used for the [clone command](/blitz/cli/clone/) and the [--url option of the start command](/blitz/cli/start). +This feature is used for the [clone command](/cli/clone/) and the [--url option of the start command](/cli/start). This feature can be disabled with the `--no-config-route` option of the start command. @@ -140,4 +140,4 @@ For exemple, this is the return of the demo `/blitz-file`: !!! tip "Want to master the syntax of Blitz?" - You can **[learn here](/blitz/blitzfile/)** how the Blitz File work. \ No newline at end of file + You can **[learn here](/blitzfile)** how the Blitz File work. \ No newline at end of file diff --git a/docs/cli/start.md b/docs/cli/start.md index d132085..8acd2a6 100644 --- a/docs/cli/start.md +++ b/docs/cli/start.md @@ -35,4 +35,4 @@ blitz start --url https://demo.blitz.paperz.app/blitz-file ``` !!! tips - You can clone the project locally with the [clone command](/blitz/cli/clone/) \ No newline at end of file + You can clone the project locally with the [clone command](/cli/clone/) \ No newline at end of file diff --git a/docs/dashboard/logs.md b/docs/dashboard/logs.md index 5fb63bf..9697dd1 100644 --- a/docs/dashboard/logs.md +++ b/docs/dashboard/logs.md @@ -4,4 +4,4 @@ The log page of the dashboard is always in WIP. The [demo version](https://demo.blitz.paperz.app/dashboard/projects/demo-blitz-app/logs) is anonymised. -Run the [blitz demo locally](/blitz/) to see more. +Run the [blitz demo locally](/) to see more. diff --git a/docs/index.md b/docs/index.md index c9912ce..45bfef4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -133,7 +133,7 @@ To start your app, you can use: !!! tip "Want to master Blitz?" - You can **[learn here](/blitz/blitzfile/)** how to create resources. + You can **[learn here](/blitzfile)** how to create resources. Just add some resources in the blitz file, and you now have a fully functional API and the corresponding database schema, along with all the modern features you can expect from a modern app like: