Skip to content

Commit

Permalink
fix: correct links in documentation (#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
daavidrgz authored Dec 28, 2024
1 parent 7793bab commit 66b406f
Show file tree
Hide file tree
Showing 8 changed files with 2,102 additions and 2,383 deletions.
2 changes: 1 addition & 1 deletion docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default defineConfig({
github: "https://github.com/jorgehermo9/gq",
},
editLink: {
baseUrl: "https://github.com/jorgehermo9/gq/tree/feature/docs/docs",
baseUrl: "https://github.com/jorgehermo9/gq/edit/main/docs",
},
customCss: ["./src/styles/custom.css"],
sidebar: [
Expand Down
4,452 changes: 2,085 additions & 2,367 deletions docs/package-lock.json

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/check": "^0.9.2",
"@astrojs/starlight": "^0.25.5",
"@astrojs/starlight-tailwind": "^2.0.3",
"@astrojs/tailwind": "^5.1.0",
"@expressive-code/plugin-line-numbers": "^0.35.6",
"astro": "^4.10.2",
"sharp": "^0.32.5",
"tailwindcss": "^3.4.10",
"typescript": "^5.5.4"
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.30.3",
"@astrojs/starlight-tailwind": "^3.0.0",
"@astrojs/tailwind": "^5.1.4",
"@expressive-code/plugin-line-numbers": "^0.38.3",
"astro": "^5.1.1",
"sharp": "^0.33.5",
"tailwindcss": "^3.4.17",
"typescript": "^5.7.2"
},
"devDependencies": {
"@biomejs/biome": "1.8.3"
"@biomejs/biome": "1.9.4"
}
}
2 changes: 1 addition & 1 deletion docs/src/content/docs/concepts/arguments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ We can use the following query if we want the products with a price lower than 3

:::note
The logical OR operator is not supported yet as it increases the complexity of the query language.\
For the moment, you can divide your conditions into multiple queries and use the [aliasing](/concepts/aliases) to avoid key conflicts.
For the moment, you can divide your conditions into multiple queries and use the [aliasing](/docs/concepts/aliases) to avoid key conflicts.
:::

## Supported operations
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/concepts/operators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ If we want to obtain the first element in the `companies` array, we can apply th

<GqExample codes={[inputQuery, outputJson]} langs={['json', 'json']} titles={['query.gq', 'output.json']} height="auto" />

This is obviously compatible with the [dot operator](/concepts/fields/#dot-operator) or any previously explained concept:
This is also compatible with the [dot operator](/docs/concepts/fields/#dot-operator) or any previously explained concept:

<GqExample codes={[dotInputQuery, dotOutputJson]} langs={['json', 'json']} titles={['query.gq', 'output.json']} height="auto" />
1 change: 1 addition & 0 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ hero:
target: _blank
rel: noopener noreferrer
icon: external
variant: secondary
---

<div className="hero-background"></div>
2 changes: 1 addition & 1 deletion docs/src/content/docs/introduction/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ cargo install gq-cli
```

:::note
If you don't have `cargo` installed, you can check how to install the Rust toolchain [here](https://www.rust-lang.org/tools/install)
If you don't have `cargo` installed, you can check how to install the Rust toolchain <a href="https://www.rust-lang.org/tools/install" target="_blank">here</a>
:::

## Compiling from source
Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/introduction/what-is.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ improvement in the **simplicity** of its underlying query language.

## Query language

Based on [GraphQL](https://graphql.org/), we wanted to extend the capabilities of an already powerful
Based on <a href="https://graphql.org/" target="_blank">GraphQL</a>, we wanted to extend the capabilities of an already powerful
QL outside the realm of API development, remodeling it from the ground up to be more suitable for
JSON filtering and accessing. let's take a look at a simple example:

Expand All @@ -31,4 +31,4 @@ As you can see, the query language has some similarities with GraphQL, including
field aliasing. However, it adds more funtionalites like the **dot operator** to access nested fields or the **extended comparison operators** to filter
array elements.

You can learn more about all the language capabilities in the [Concepts Section](/concepts/fields).
You can learn more about all the language capabilities in the [Concepts Section](/docs/concepts/fields).

0 comments on commit 66b406f

Please sign in to comment.