Skip to content

Chore: Make indentations dynamic #171

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.

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

Merged
merged 1 commit into from
Jul 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 docs/_quickstart_template.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Go ahead and ask a question! In the next steps, we'll take a deeper look at inte

While it's great that we can ask questions about the data set, what if the application could take action on our behalf?
Such as rent a movie for us? We can easily do this by adding custom business logic using one of our
[lambda connectors](/business-logic/overview.mdx). In the example below, we'll use TypeScript.
[lambda connectors](/business-logic/index.mdx). In the example below, we'll use TypeScript.

```ddn title="Like before, let's initialize this connector:"
ddn connector init promptflix -i
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ performance through the distributed execution layer.
## Next steps

With a broad perspective of the different services powering a PromptQL application, we recommend learning more about the
[semantic metadata layer](/data-modeling/overview.mdx) next.
[semantic metadata layer](/data-modeling/index.mdx) next.
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/auth/permissions/model-permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ object. Each item in the array should have a `role` field and a `select` field.
`filter` expression that determines which rows are accessible to the role when selecting from the model.

Most commonly, you'll use session variables — accessed by the query engine via your configured
[authentication mechanism](/auth/overview.mdx) in a JWT or body of a webhook response — to restrict access to rows based
on the user's role, identity or other criteria.
[authentication mechanism](/auth/index.mdx) in a JWT or body of a webhook response — to restrict access to rows based on
the user's role, identity or other criteria.

This filter expression can reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ different roles and environments.
## Learn more about permissions and auth

- [Permissions](/auth/permissions/index.mdx)
- [Auth](/auth/overview.mdx)
- [Auth](/auth/index.mdx)

## Similar tutorials

Expand Down
2 changes: 1 addition & 1 deletion docs/auth/permissions/tutorials/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ seoFrontMatterUpdated: false
In this section of tutorials, we'll provide step-by-step guides for common patterns in controlling users' access to data
via your metadata.

If you're unfamiliar with how the query engine handles authorization, [check out the docs](/auth/overview.mdx) before
If you're unfamiliar with how the query engine handles authorization, [check out the docs](/auth/index.mdx) before
diving deeper into one of these tutorials.

## Recipes
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/capabilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ means something specific in your business, or that certain metrics should always

:::info Learn more

You can learn more about PromptQL's semantic understanding [here](/data-modeling/overview.mdx).
You can learn more about PromptQL's semantic understanding [here](/data-modeling/index.mdx).

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/data-modeling/command.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ When setting up commands for use with PromptQL, follow this lifecycle:
## Create a command

To add a command you will need to have a data connector already set up and connected to the data source. Follow the
[Quickstart](/quickstart.mdx) or the tutorial in [How to Build with DDN](/how-to-build-with-promptql/overview.mdx) to
get to that point.
[Quickstart](/quickstart.mdx) or the tutorial in [How to Build with DDN](/how-to-build-with-promptql/index.mdx) to get
to that point.

### From a source operation

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/data-modeling/model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ Creating models for your PromptQL's metadata layer involves the following steps:
## Create a model

To add a model you will need to have a data connector already set up and connected to the data source. Follow the
relevant tutorial for your data source in [How to Build with PromptQL](/how-to-build-with-promptql/overview.mdx) to get
to that point.
relevant tutorial for your data source in [How to Build with PromptQL](/how-to-build-with-promptql/index.mdx) to get to
that point.

### From a source entity

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/data-sources/introspect-a-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ up-to-date with your source schema.**
## Next steps

With your source introspected and the configuration files populated, you can now start adding this information to your
agentic semantic metadata layer. Check out the [Data Modeling](/data-modeling/overview.mdx) section to begin creating
agentic semantic metadata layer. Check out the [Data Modeling](/data-modeling/index.mdx) section to begin creating
models, commands, and relationships for your data.
2 changes: 1 addition & 1 deletion docs/data-sources/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ ddn supergraph build <local|create>

:::info I need all of my tables

If all tracked tables are needed, and you're running into build issues, [raise a ticket](/help/overview.mdx).
If all tracked tables are needed, and you're running into build issues, [raise a ticket](/help/index.mdx).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/hasura-ddn/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

Deploying to Hasura DDN is the optimal way to enable PromptQL to accurately talk to all your data. Hasura DDN provides
the data foundation that powers PromptQL's intelligent data interaction capabilities. For more details on dedicated
infrastructure, see [Hasura Private DDN](/private-ddn/overview.mdx). For more details on pricing plans, see
infrastructure, see [Hasura Private DDN](/private-ddn/index.mdx). For more details on pricing plans, see
[our pricing page](https://hasura.io/pricing).

## Hasura DDN
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/overview.mdx → docs/deployment/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ You can also host your [Data Plane](/help/glossary#data-plane) on your own infra
- Custom infrastructure requirements
- Compliance with specific regulatory requirements

[Read more](/private-ddn/overview.mdx)
[Read more](/private-ddn/index.mdx)
6 changes: 3 additions & 3 deletions docs/help/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Data connectors are available for a wide variety of sources including databases,
and GraphQL APIs. They can be official Hasura-verified connectors or custom-built connectors to integrate with other
data sources.

[Learn more](/data-sources/overview.mdx).
[Learn more](/data-sources/index.mdx).

## Push-Down Capabilities

Expand Down Expand Up @@ -320,14 +320,14 @@ The supergraph config tells the metadata build service (which we take care of ru
how to construct your supergraph. A config will contain information such as which subgraphs to include and which
resources to use for the build.

[Learn more](/project-configuration/overview.mdx).
[Learn more](/project-configuration/index.mdx).

## Connector config

The connector config tells the MBS how to build your connector. It will contain information such as the type of
connector and the location to the context files needed to build the connector.

[Learn more](/project-configuration/overview.mdx).
[Learn more](/project-configuration/index.mdx).

## DDN CLI (Command-Line Interface)

Expand Down
8 changes: 4 additions & 4 deletions docs/help/overview.mdx → docs/help/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ keywords:
### Explore the docs

Start by exploring our [quickstart guide](/quickstart.mdx) to get up and running with PromptQL or dive into the
[tutorials](/how-to-build-with-promptql/overview.mdx) for a step-by-step approach to connect PromptQL to your data
sources. Once you're comfortable, expand your knowledge with sections like [data sources](data-sources/overview.mdx),
[data modeling](data-modeling/overview.mdx), [auth](auth/overview.mdx), and [deployment](deployment/overview.mdx) to
enhance how PromptQL interacts with your data.
[tutorials](/how-to-build-with-promptql/index.mdx) for a step-by-step approach to connect PromptQL to your data sources.
Once you're comfortable, expand your knowledge with sections like [data sources](data-sources/index.mdx),
[data modeling](data-modeling/index.mdx), [auth](auth/index.mdx), and [deployment](deployment/index.mdx) to enhance how
PromptQL interacts with your data.

### Ask the community

Expand Down
4 changes: 2 additions & 2 deletions docs/help/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ internet (allowing connections from `0.0.0.0/0`). This is because Hasura DDN ope
not provide static IP addresses for connections.

If your security requirements necessitate the use of static IP addresses or private network connectivity, consider using
[Hasura Private DDN](/private-ddn/overview.mdx), which allows you to host the data plane within your own infrastructure.
[Hasura Private DDN](/private-ddn/index.mdx), which allows you to host the data plane within your own infrastructure.

## Metadata Storage and Handling

Expand Down Expand Up @@ -118,7 +118,7 @@ to whatever you'd like.

For enhanced security and control, Hasura Private DDN allows the data plane to be hosted within your own infrastructure.
This ensures that the data processing and execution occur within your controlled environment, providing an added layer
of security. [Learn more](/private-ddn/overview.mdx).
of security. [Learn more](/private-ddn/index.mdx).

## Access Tokens

Expand Down
4 changes: 2 additions & 2 deletions docs/how-to-build-with-promptql/_boilerplateSummary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ Here's what you just accomplished:
Now, you're equipped to connect and expose your data, empowering you to iterate and scale with confidence. Great work!

Take a look at our [connector docs](/reference/connectors/index.mdx) to learn more about how to use PromptQL with
{props.dataSourceName}. Or, if you're ready, get started with
[adding custom business logic](/business-logic/overview.mdx) to get PromptQL to act on a user's behalf!
{props.dataSourceName}. Or, if you're ready, get started with [adding custom business logic](/business-logic/index.mdx)
to get PromptQL to act on a user's behalf!
File renamed without changes.
6 changes: 3 additions & 3 deletions docs/private-ddn/create-a-project-on-a-data-plane.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import Prereqs from "@site/docs/_prereqs.mdx";
:::tip Important

This guide will walk you through the steps for creating a project on a Data Plane in
[Private Hasura DDN](/private-ddn/overview.mdx). Before proceeding, you'll first need to be
[Private Hasura DDN](/private-ddn/index.mdx). Before proceeding, you'll first need to be
[invited](/private-ddn/data-plane-collaboration.mdx) to a Data Plane.

If you are unable to meet the prerequisites listed below or your data source is inaccessible from the location where you
Expand Down Expand Up @@ -83,7 +83,7 @@ ddn relationship add <connector_name> '*'
```

You'll see metadata files generated for each entity in your data source. You can learn more
[here](/data-modeling/overview.mdx).
[here](/data-modeling/index.mdx).

## Step 5. Create a new local build

Expand Down Expand Up @@ -113,5 +113,5 @@ When this process is complete, the CLI will return a link to the hosted applicat

## Next steps

With your first project created, learn more about how Hasura handles [data modeling](/data-modeling/overview.mdx) before
With your first project created, learn more about how Hasura handles [data modeling](/data-modeling/index.mdx) before
diving into advanced features.
4 changes: 2 additions & 2 deletions docs/private-ddn/ddn-workspace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ install DDN CLI and its dependencies locally. It features a familiar VS Code-lik
and includes all necessary dependencies required to work with DDN pre-installed.

This guide will walk you through the steps for using DDN workspace to develop your API on a Data Plane in
[Private Hasura DDN](/private-ddn/overview.mdx). Before proceeding, you'll first need to be
[Private Hasura DDN](/private-ddn/index.mdx). Before proceeding, you'll first need to be
[invited](/private-ddn/data-plane-collaboration.mdx) to a Data Plane.

:::info Prerequisite
Expand Down Expand Up @@ -165,7 +165,7 @@ ddn relationship add <connector_name> '*'
```

Metadata files will be generated for each entity in your data source. You can learn more
[here](/data-modeling/overview.mdx).
[here](/data-modeling/index.mdx).

:::info Note

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ definition:
```

Then similarly, we would have the supergraph file for the other environments to use which specifies JWT mode in the
`auth-config.yaml` file. You can read more about [auth here](/auth/overview.mdx).
`auth-config.yaml` file. You can read more about [auth here](/auth/index.mdx).
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ The `--project`, `--supergraph` and `--env-file` flags can be skipped if the key

### Step 4. (Optional) Add a custom script to build the supergraph

You can add the above command as a [custom script](/project-configuration/overview.mdx) the `--no-build-connectors` flag
You can add the above command as a [custom script](/project-configuration/index.mdx) the `--no-build-connectors` flag
each time.

For example, you can update your context config to the following:
Expand Down Expand Up @@ -167,4 +167,4 @@ The `--project`, `--supergraph` and `--env-file` flags can be skipped if the key

## Learn more

- [Project configuration](/project-configuration/overview.mdx)
- [Project configuration](/project-configuration/index.mdx)
10 changes: 5 additions & 5 deletions docs/project-configuration/tutorials/remove-subgraph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ directory is typically located at `<subgraph-name>`.

### Step 2. Update supergraph config files

Remove the path to the subgraph config files in all [supergraph config files](/project-configuration/overview.mdx)
located at the project root, i.e., `<project-root>/supergraph.yaml`.
Remove the path to the subgraph config files in all [supergraph config files](/project-configuration/index.mdx) located
at the project root, i.e., `<project-root>/supergraph.yaml`.

```yaml title="supergraph.yaml"
kind: Supergraph
Expand Down Expand Up @@ -70,8 +70,8 @@ services:

### Step 4. Remove subgraph config file from context

The [context config file](/project-configuration/overview.mdx) subgraph config file path saved in the context. Remove
the `subgraph` key if set as the deleted subgraph config file.
The [context config file](/project-configuration/index.mdx) subgraph config file path saved in the context. Remove the
`subgraph` key if set as the deleted subgraph config file.

```yaml title=".hasura/context.yaml"
kind: Context
Expand Down Expand Up @@ -104,4 +104,4 @@ CLI-generated environment variables for a subgraph typically start with the `<SU

## Learn more

- [Project configuration](/project-configuration/overview.mdx)
- [Project configuration](/project-configuration/index.mdx)
24 changes: 12 additions & 12 deletions docs/project-configuration/tutorials/rename-subgraph.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Before continuing, ensure you have:

### Step 1. Update subgraph config files

Update the name of the subgraph in all the [subgraph config files](/project-configuration/overview.mdx) the subgraph.
The subgraph config is typically located at `<subgraph-name>/subgraph.yaml`.
Update the name of the subgraph in all the [subgraph config files](/project-configuration/index.mdx) the subgraph. The
subgraph config is typically located at `<subgraph-name>/subgraph.yaml`.

```yaml title="<subgraph-name>/subgraph.yaml"
kind: Subgraph
Expand All @@ -51,8 +51,8 @@ definition:

### Step 2. Update connector config files of the subgraph

Update the reference of the subgraph in all the [connector config files](/project-configuration/overview.mdx) subgraph.
The connector config is typically located at `<subgraph-name>/connector/<connector-name>/connector.yaml`.
Update the reference of the subgraph in all the [connector config files](/project-configuration/index.mdx) subgraph. The
connector config is typically located at `<subgraph-name>/connector/<connector-name>/connector.yaml`.

```yaml title="<subgraph-name>/connector/<connector-name>/connector.yaml"
kind: Connector
Expand All @@ -69,7 +69,7 @@ definition:

### Step 3. Update compose files of connectors of the subgraph

Update the name of the connector service in the [compose file](/project-configuration/overview.mdx) the connectors
Update the name of the connector service in the [compose file](/project-configuration/index.mdx) the connectors
belonging to the subgraph. The connector compose file is typically located at
`<project-root>/<subgraph-name>/connector/<connector-name>/compose.yaml`.

Expand All @@ -96,8 +96,8 @@ typically be in:

#### Step 4.1. Supergraph config files

Update the path to the subgraph config files in all [supergraph config files](/project-configuration/overview.mdx)
located at the project root, i.e., `<project-root>/supergraph.yaml`.
Update the path to the subgraph config files in all [supergraph config files](/project-configuration/index.mdx) located
at the project root, i.e., `<project-root>/supergraph.yaml`.

```yaml title="supergraph.yaml"
kind: Supergraph
Expand All @@ -113,8 +113,8 @@ definition:

#### Step 4.2. Engine compose file

Update the path to the connector compose files included in the engine
[compose file](/project-configuration/overview.mdx) project root, i.e., `<project-root>/compose.yaml`.
Update the path to the connector compose files included in the engine [compose file](/project-configuration/index.mdx)
project root, i.e., `<project-root>/compose.yaml`.

```yaml title="compose.yaml"
include:
Expand All @@ -131,8 +131,8 @@ services:

#### Step 4.3. Context config

The [context config file](/project-configuration/overview.mdx) subgraph config file path saved in the context. Update
the subgraph config path if set.
The [context config file](/project-configuration/index.mdx) subgraph config file path saved in the context. Update the
subgraph config path if set.

```yaml title=".hasura/context.yaml"
kind: Context
Expand All @@ -150,4 +150,4 @@ definition:

## Learn more

- [Project configuration](/project-configuration/overview.mdx)
- [Project configuration](/project-configuration/index.mdx)
4 changes: 2 additions & 2 deletions docs/promptql-apis/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

PromptQL endpoints accept a `ddn` object which contains details like your project's URL and what headers to pass along.
These endpoints accept all DDN-compatible authentication strategies; learn more about these in our
[auth docs](/auth/overview.mdx).
[auth docs](/auth/index.mdx).

## Modes

Expand Down Expand Up @@ -59,6 +59,6 @@ These endpoints accept all DDN-compatible authentication strategies; learn more
:::info Authorization Strategies

The example above uses the Bearer strategy for the `tokenLocation`. Your setup may be different; consult our
[auth docs](/auth/overview.mdx) for more information about setting up an authentication mode.
[auth docs](/auth/index.mdx) for more information about setting up an authentication mode.

:::
2 changes: 1 addition & 1 deletion docs/promptql-apis/execute-program-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import Thumbnail from "@site/src/components/Thumbnail";
## Introduction

Under the hood, PromptQL utilizes a set of built-in primitives, in conjunction with any
[custom business logic](/business-logic/overview.mdx) you've provided, to create small programs on top of your data.
[custom business logic](/business-logic/index.mdx) you've provided, to create small programs on top of your data.

These primitives pair relevant data or artifacts—represented as `inputs` or `data`—from your application with on-the-fly
and context-aware `instructions` based on the thread between the user and PromptQL.
Expand Down
File renamed without changes.
3 changes: 1 addition & 2 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ If you have your own project, you can apply the information below to it. Otherwi
[collection of sandboxes](/index.mdx#demos) which allow you to try PromptQL and get a feel for the experience. Below,
we'll use the `sandbox-gtm` example.

If you're looking to build a new project from scratch, check out
[these guides](/how-to-build-with-promptql/overview.mdx).
If you're looking to build a new project from scratch, check out [these guides](/how-to-build-with-promptql/index.mdx).

:::

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/reference/overview.mdx → docs/reference/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ In this section of docs, you'll find reference material for:

This section of documentation is designed to be an exhaustive **reference** of Hasura DDN, the underlying data layer for
PromptQL. To see implementation docs for these concepts, check out the tutorials and guides in sections like
[How to Build With PromptQL](/how-to-build-with-promptql/overview.mdx).
[How to Build With PromptQL](/how-to-build-with-promptql/index.mdx).
Loading
Loading