Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

change the /blitz preffix in the documentation (#39) #40

Merged
merged 1 commit into from
Mar 20, 2024
+7 −7
Merged

change the /blitz preffix in the documentation (#39) #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion blitz/cli/commands/clone.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions docs/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.
You can **[learn here](/blitzfile)** how the Blitz File work.
2 changes: 1 addition & 1 deletion docs/cli/start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
You can clone the project locally with the [clone command](/cli/clone/)
2 changes: 1 addition & 1 deletion docs/dashboard/logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading