Skip to content

Commit ada63fe

Browse files
Chore: Refactor sidebar (#171)
## Description πŸ“ Chore: Modify names from overview to index Chore: Update refs
1 parent 3c62794 commit ada63fe

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+691
-887
lines changed

β€Ždocs/_quickstart_template.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Go ahead and ask a question! In the next steps, we'll take a deeper look at inte
110110

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

115115
```ddn title="Like before, let's initialize this connector:"
116116
ddn connector init promptflix -i

β€Ždocs/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,4 @@ performance through the distributed execution layer.
7171
## Next steps
7272

7373
With a broad perspective of the different services powering a PromptQL application, we recommend learning more about the
74-
[semantic metadata layer](/data-modeling/overview.mdx) next.
74+
[semantic metadata layer](/data-modeling/index.mdx) next.
File renamed without changes.

β€Ždocs/auth/permissions/model-permissions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ object. Each item in the array should have a `role` field and a `select` field.
2121
`filter` expression that determines which rows are accessible to the role when selecting from the model.
2222

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

2727
This filter expression can reference
2828

β€Ždocs/auth/permissions/tutorials/1-simple-user-permissions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ different roles and environments.
138138
## Learn more about permissions and auth
139139

140140
- [Permissions](/auth/permissions/index.mdx)
141-
- [Auth](/auth/overview.mdx)
141+
- [Auth](/auth/index.mdx)
142142

143143
## Similar tutorials
144144

β€Ždocs/auth/permissions/tutorials/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ seoFrontMatterUpdated: false
1818
In this section of tutorials, we'll provide step-by-step guides for common patterns in controlling users' access to data
1919
via your metadata.
2020

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

2424
## Recipes

β€Ždocs/capabilities.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ means something specific in your business, or that certain metrics should always
4040

4141
:::info Learn more
4242

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

4545
:::
4646

β€Ždocs/data-modeling/command.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ When setting up commands for use with PromptQL, follow this lifecycle:
4747
## Create a command
4848

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

5353
### From a source operation
5454

File renamed without changes.

β€Ždocs/data-modeling/model.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Creating models for your PromptQL's metadata layer involves the following steps:
4343
## Create a model
4444

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

4949
### From a source entity
5050

File renamed without changes.

β€Ždocs/data-sources/introspect-a-source.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,5 +58,5 @@ up-to-date with your source schema.**
5858
## Next steps
5959

6060
With your source introspected and the configuration files populated, you can now start adding this information to your
61-
agentic semantic metadata layer. Check out the [Data Modeling](/data-modeling/overview.mdx) section to begin creating
61+
agentic semantic metadata layer. Check out the [Data Modeling](/data-modeling/index.mdx) section to begin creating
6262
models, commands, and relationships for your data.

β€Ždocs/data-sources/troubleshooting.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ ddn supergraph build <local|create>
148148

149149
:::info I need all of my tables
150150

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

153153
:::
154154

β€Ždocs/deployment/hasura-ddn/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ keywords:
1414

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

2020
## Hasura DDN

β€Ždocs/deployment/overview.mdx renamed to β€Ždocs/deployment/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ You can also host your [Data Plane](/help/glossary#data-plane) on your own infra
4646
- Custom infrastructure requirements
4747
- Compliance with specific regulatory requirements
4848

49-
[Read more](/private-ddn/overview.mdx)
49+
[Read more](/private-ddn/index.mdx)

β€Ždocs/help/glossary.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Data connectors are available for a wide variety of sources including databases,
215215
and GraphQL APIs. They can be official Hasura-verified connectors or custom-built connectors to integrate with other
216216
data sources.
217217

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

220220
## Push-Down Capabilities
221221

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

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

325325
## Connector config
326326

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

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

332332
## DDN CLI (Command-Line Interface)
333333

β€Ždocs/help/overview.mdx renamed to β€Ždocs/help/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ keywords:
2121
### Explore the docs
2222

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

2929
### Ask the community
3030

β€Ždocs/help/security.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ internet (allowing connections from `0.0.0.0/0`). This is because Hasura DDN ope
5252
not provide static IP addresses for connections.
5353

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

5757
## Metadata Storage and Handling
5858

@@ -118,7 +118,7 @@ to whatever you'd like.
118118

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

123123
## Access Tokens
124124

β€Ždocs/how-to-build-with-promptql/_boilerplateSummary.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@ Here's what you just accomplished:
1313
Now, you're equipped to connect and expose your data, empowering you to iterate and scale with confidence. Great work!
1414

1515
Take a look at our [connector docs](/reference/connectors/index.mdx) to learn more about how to use PromptQL with
16-
{props.dataSourceName}. Or, if you're ready, get started with
17-
[adding custom business logic](/business-logic/overview.mdx) to get PromptQL to act on a user's behalf!
16+
{props.dataSourceName}. Or, if you're ready, get started with [adding custom business logic](/business-logic/index.mdx)
17+
to get PromptQL to act on a user's behalf!
File renamed without changes.

β€Ždocs/private-ddn/create-a-project-on-a-data-plane.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import Prereqs from "@site/docs/_prereqs.mdx";
2020
:::tip Important
2121

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

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

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

8888
## Step 5. Create a new local build
8989

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

114114
## Next steps
115115

116-
With your first project created, learn more about how Hasura handles [data modeling](/data-modeling/overview.mdx) before
116+
With your first project created, learn more about how Hasura handles [data modeling](/data-modeling/index.mdx) before
117117
diving into advanced features.

β€Ždocs/private-ddn/ddn-workspace.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ install DDN CLI and its dependencies locally. It features a familiar VS Code-lik
2323
and includes all necessary dependencies required to work with DDN pre-installed.
2424

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

2929
:::info Prerequisite
@@ -165,7 +165,7 @@ ddn relationship add <connector_name> '*'
165165
```
166166

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

170170
:::info Note
171171

File renamed without changes.

β€Ždocs/project-configuration/project-management/manage-environments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@ definition:
5555
```
5656
5757
Then similarly, we would have the supergraph file for the other environments to use which specifies JWT mode in the
58-
`auth-config.yaml` file. You can read more about [auth here](/auth/overview.mdx).
58+
`auth-config.yaml` file. You can read more about [auth here](/auth/index.mdx).

β€Ždocs/project-configuration/tutorials/independent-connector-deployment.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ The `--project`, `--supergraph` and `--env-file` flags can be skipped if the key
124124

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

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

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

168168
## Learn more
169169

170-
- [Project configuration](/project-configuration/overview.mdx)
170+
- [Project configuration](/project-configuration/index.mdx)

β€Ždocs/project-configuration/tutorials/remove-subgraph.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ directory is typically located at `<subgraph-name>`.
3737

3838
### Step 2. Update supergraph config files
3939

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

4343
```yaml title="supergraph.yaml"
4444
kind: Supergraph
@@ -70,8 +70,8 @@ services:
7070
7171
### Step 4. Remove subgraph config file from context
7272
73-
The [context config file](/project-configuration/overview.mdx) subgraph config file path saved in the context. Remove
74-
the `subgraph` key if set as the deleted subgraph config file.
73+
The [context config file](/project-configuration/index.mdx) subgraph config file path saved in the context. Remove the
74+
`subgraph` key if set as the deleted subgraph config file.
7575

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

105105
## Learn more
106106

107-
- [Project configuration](/project-configuration/overview.mdx)
107+
- [Project configuration](/project-configuration/index.mdx)

β€Ždocs/project-configuration/tutorials/rename-subgraph.mdx

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Before continuing, ensure you have:
3232

3333
### Step 1. Update subgraph config files
3434

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

3838
```yaml title="<subgraph-name>/subgraph.yaml"
3939
kind: Subgraph
@@ -51,8 +51,8 @@ definition:
5151
5252
### Step 2. Update connector config files of the subgraph
5353
54-
Update the reference of the subgraph in all the [connector config files](/project-configuration/overview.mdx) subgraph.
55-
The connector config is typically located at `<subgraph-name>/connector/<connector-name>/connector.yaml`.
54+
Update the reference of the subgraph in all the [connector config files](/project-configuration/index.mdx) subgraph. The
55+
connector config is typically located at `<subgraph-name>/connector/<connector-name>/connector.yaml`.
5656

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

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

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

@@ -96,8 +96,8 @@ typically be in:
9696

9797
#### Step 4.1. Supergraph config files
9898

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

102102
```yaml title="supergraph.yaml"
103103
kind: Supergraph
@@ -113,8 +113,8 @@ definition:
113113

114114
#### Step 4.2. Engine compose file
115115

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

119119
```yaml title="compose.yaml"
120120
include:
@@ -131,8 +131,8 @@ services:
131131

132132
#### Step 4.3. Context config
133133

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

137137
```yaml title=".hasura/context.yaml"
138138
kind: Context
@@ -150,4 +150,4 @@ definition:
150150

151151
## Learn more
152152

153-
- [Project configuration](/project-configuration/overview.mdx)
153+
- [Project configuration](/project-configuration/index.mdx)

β€Ždocs/promptql-apis/auth.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ keywords:
1414

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

1919
## Modes
2020

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

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

6464
:::

β€Ždocs/promptql-apis/execute-program-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import Thumbnail from "@site/src/components/Thumbnail";
1616
## Introduction
1717

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

2121
These primitives pair relevant data or artifactsβ€”represented as `inputs` or `data`β€”from your application with on-the-fly
2222
and context-aware `instructions` based on the thread between the user and PromptQL.
File renamed without changes.

β€Ždocs/quickstart.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ If you have your own project, you can apply the information below to it. Otherwi
2828
[collection of sandboxes](/index.mdx#demos) which allow you to try PromptQL and get a feel for the experience. Below,
2929
we'll use the `sandbox-gtm` example.
3030

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

3433
:::
3534

File renamed without changes.

β€Ždocs/reference/overview.mdx renamed to β€Ždocs/reference/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ In this section of docs, you'll find reference material for:
2626

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

0 commit comments

Comments
Β (0)