Skip to content

Commit ecbe09b

Browse files
cameroncfphortx
authored andcommitted
Fixes some broken documentation links (#76)
* Fixing some broken documentation links. * Whoops - missed fixing up one more broken link. * Fixing more broken links
1 parent 72f1d4c commit ecbe09b

File tree

3 files changed

+38
-38
lines changed

3 files changed

+38
-38
lines changed

docs/guide/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ The following table lists all actions and what they do:
3434

3535
CRUD | Vuex Only | Persist to GraphQL API
3636
--| -- | --
37-
**R**EAD | [`find()`](https://vuex-orm.github.io/vuex-orm/store/retrieving-data.html#get-single-data), [`all()`](https://vuex-orm.github.io/vuex-orm/store/retrieving-data.html#get-all-data), [`query()`](https://vuex-orm.github.io/vuex-orm/store/retrieving-data.html#query-builder) | [`fetch()`](/guide/fetch)
38-
**C**REATE | [`create()`](https://vuex-orm.github.io/vuex-orm/store/inserting-and-updating-data.html#inserts) or [`insert()`](https://vuex-orm.github.io/vuex-orm/store/inserting-and-updating-data.html#inserts) | [`$persist()`](/guide/persist)
39-
**U**PDATE | [`$update()`](https://vuex-orm.github.io/vuex-orm/store/inserting-and-updating-data.html#updates) | [`$push()`](/guide/push)
40-
**D**ELETE | [`$delete()`](https://vuex-orm.github.io/vuex-orm/store/deleting-data.html) | [`$destroy()`](/guide/destroy)
37+
**R**EAD | [`find()`](https://vuex-orm.github.io/vuex-orm/guide/store/retrieving-data.html#get-single-data), [`all()`](https://vuex-orm.github.io/vuex-orm/guide/store/retrieving-data.html#get-all-data), [`query()`](https://vuex-orm.github.io/vuex-orm/guide/store/retrieving-data.html#query-builder) | [`fetch()`](fetch.md)
38+
**C**REATE | [`create()`](https://vuex-orm.github.io/vuex-orm/guide/store/inserting-and-updating-data.html#inserts) or [`insert()`](https://vuex-orm.github.io/vuex-orm/guide/store/inserting-and-updating-data.html#inserts) | [`$persist()`](persist.md)
39+
**U**PDATE | [`$update()`](https://vuex-orm.github.io/vuex-orm/guide/store/inserting-and-updating-data.html#updates) | [`$push()`](push.md)
40+
**D**ELETE | [`$delete()`](https://vuex-orm.github.io/vuex-orm/guide/store/deleting-data.html) | [`$destroy()`](destroy.md)
4141

4242
See the example below to get an idea of how this plugin interacts with Vuex-ORM.
4343

@@ -46,14 +46,14 @@ See the example below to get an idea of how this plugin interacts with Vuex-ORM.
4646

4747
## Example usage
4848

49-
After [installing](/guide/setup) this plugin you can load data in your component:
49+
After [installing](setup.md) this plugin you can load data in your component:
5050

5151
```vue
5252
<template>
5353
<ul>
5454
<li v-for="user in users" :key="user.id">
5555
{{user.name}}
56-
56+
5757
<a href="#" @click.prevent="destroy(user)">x</a>
5858
</li>
5959
</ul>
@@ -62,12 +62,12 @@ After [installing](/guide/setup) this plugin you can load data in your component
6262
6363
<script>
6464
import User from 'data/models/user';
65-
65+
6666
export default {
6767
computed: {
6868
/**
6969
* Returns all users with reactivity.
70-
*/
70+
*/
7171
users: () => User.query().withAll().all()
7272
},
7373
@@ -76,11 +76,11 @@ After [installing](/guide/setup) this plugin you can load data in your component
7676
// Load all users form the server
7777
await User.fetch();
7878
},
79-
80-
79+
80+
8181
methods: {
8282
/**
83-
* Deletes the user from Vuex Store and from the server.
83+
* Deletes the user from Vuex Store and from the server.
8484
*/
8585
async destroy(user) {
8686
await user.$deleteAndDestroy();
@@ -100,7 +100,7 @@ Vuex-ORM-GraphQL works with the [Apollo Dev Tools](https://chrome.google.com/web
100100
It seems that there are several standards within the GraphQL community how connections (fields that returns multiple
101101
records) are designed. Some do this via a `nodes` field, some via a `edges { nodes }` query and some do neither of them.
102102
Vuex-ORM-GraphQL tries to be flexible and supports all of them, but the example queries in the documentation work with
103-
the `nodes` query, don't be irritated. You'll find [more details here](/guide/connection-mode).
103+
the `nodes` query, don't be irritated. You'll find [more details here](connection-mode.md).
104104

105105

106106
## License

docs/guide/relationships.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
[[toc]]
44

55
This chapter describes how the GraphQL-Plugin interacts with relationships. All relationships work out of the box.
6-
We take the examples from the [Vuex-ORM documentation for definition relationships](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html)
6+
We take the examples from the [Vuex-ORM documentation for definition relationships](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html)
77
and show what GraphQL queries will be generated.
88

99

1010
## One To One
1111

1212
::: tip
13-
See the [One To One section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#one-to-one) in the Vuex-ORM documentation.
14-
:::
13+
See the [One To One section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#one-to-one) in the Vuex-ORM documentation.
14+
:::
1515

1616
Is eager loaded automatically.
1717

@@ -52,7 +52,7 @@ query Users {
5252
nodes {
5353
id
5454
name
55-
55+
5656
profile {
5757
id
5858
age
@@ -73,7 +73,7 @@ query Profiles {
7373
age
7474
sex
7575
userId
76-
76+
7777
user {
7878
id
7979
name
@@ -86,10 +86,10 @@ query Profiles {
8686
## One To Many
8787

8888
::: tip
89-
See the [One To Many section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#one-to-many) in the Vuex-ORM documentation.
90-
:::
89+
See the [One To Many section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#one-to-many) in the Vuex-ORM documentation.
90+
:::
9191

92-
BelongsTo is eager loaded automatically while HasMany is not eager loaded.
92+
BelongsTo is eager loaded automatically while HasMany is not eager loaded.
9393

9494
**Models:**
9595
```javascript
@@ -128,7 +128,7 @@ query Comments {
128128
id
129129
postId
130130
content
131-
131+
132132
post {
133133
id
134134
content
@@ -160,8 +160,8 @@ As you can see the comments are not eager loaded.
160160
## Many To Many
161161

162162
::: tip
163-
See the [Many To Many section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#many-to-many) in the Vuex-ORM documentation.
164-
:::
163+
See the [Many To Many section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#many-to-many) in the Vuex-ORM documentation.
164+
:::
165165

166166
Is NOT eager loaded automatically, so we add a eagerLoad field to User.
167167

@@ -213,7 +213,7 @@ query Users {
213213
nodes {
214214
id
215215
email
216-
216+
217217
roles {
218218
nodes {
219219
id
@@ -244,13 +244,13 @@ query Roles {
244244
## Has Many Through
245245

246246
::: tip
247-
See the [Has Any Through section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#has-many-through) in the Vuex-ORM documentation.
248-
:::
247+
See the [Has Any Through section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#has-many-through) in the Vuex-ORM documentation.
248+
:::
249249

250250
Is NOT eager loaded automatically.
251251

252252
In this example we have a Product which can belong to many ProductGroups. And a ProductGroup can have many Products.
253-
This is a classical n:m relation type, which we setup via HasManyThrough and a Pivot Model (ProductsProductGroup)
253+
This is a classical n:m relation type, which we setup via HasManyThrough and a Pivot Model (ProductsProductGroup)
254254

255255
**Models:**
256256
```javascript
@@ -316,7 +316,7 @@ query Users {
316316
id
317317
email
318318
countryId
319-
319+
320320
country {
321321
id
322322
name
@@ -334,12 +334,12 @@ query Posts {
334334
id
335335
title
336336
content
337-
337+
338338
user {
339339
id
340340
email
341341
countryId
342-
342+
343343
country {
344344
id
345345
name
@@ -354,8 +354,8 @@ query Posts {
354354
## Polymorphic Relations
355355

356356
::: tip
357-
See the [Polymorphic Relations section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#polymorphic-relations) in the Vuex-ORM documentation.
358-
:::
357+
See the [Polymorphic Relations section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#polymorphic-relations) in the Vuex-ORM documentation.
358+
:::
359359

360360
Eager loading behaves like in a normal One To Many or One to One. So we add a `eagerLoad` field to make sure the
361361
comments are loaded automatically with the post or video.
@@ -412,7 +412,7 @@ query Posts {
412412
id
413413
title
414414
content
415-
415+
416416
comments {
417417
nodes {
418418
id
@@ -430,8 +430,8 @@ query Posts {
430430
## Many To Many Polymorphic Relations
431431

432432
::: tip
433-
See the [Many To Many Polymorphic Relations section](https://vuex-orm.github.io/vuex-orm/relationships/defining-relationships.html#many-to-many-polymorphic-relations) in the Vuex-ORM documentation.
434-
:::
433+
See the [Many To Many Polymorphic Relations section](https://vuex-orm.github.io/vuex-orm/guide/relationships/defining-relationships.html#many-to-many-polymorphic-relations) in the Vuex-ORM documentation.
434+
:::
435435

436436
Eager loading behaves the same as in a normal Many To Many: Nothing is eager loaded automatically. So we add a
437437
`eagerLoad` field to make sure the tags are loaded automatically with the post or video.
@@ -499,7 +499,7 @@ query Posts {
499499
id
500500
title
501501
content
502-
502+
503503
tags {
504504
nodes {
505505
id

docs/guide/setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install --save @vuex-orm/plugin-graphql
1818
```
1919

2020

21-
After that we setup the plugin. Add this after [registering your models to the database](https://vuex-orm.github.io/vuex-orm/prologue/getting-started.html#register-models-and-modules-to-the-vuex-store):
21+
After that we setup the plugin. Add this after [registering your models to the database](https://vuex-orm.github.io/vuex-orm/guide/prologue/getting-started.html#register-models-and-modules-to-the-vuex-store):
2222

2323
```javascript
2424
import VuexORMGraphQL from '@vuex-orm/plugin-graphql';
@@ -37,7 +37,7 @@ These are the possible options to pass when calling `VuexORM.use()`:
3737
This can be a static object or a function, returning a object, which will be called before a request is made.
3838
- `credentials` (optional, default: `same-origin`) Credentials Policy. See [apollo-link-http])(https://github.com/apollographql/apollo-link/tree/master/packages/apollo-link-http#options)
3939
- `useGETForQueries` (optional, default: `false`) Use GET for queries (not for mutations). See [apollo-link-http])(https://github.com/apollographql/apollo-link/tree/master/packages/apollo-link-http#options)
40-
- `connectionQueryMode` (optional, default: `auto`). One of `auto | nodes | edges | plain`. See [Connection Mode](/guide/connection-mode)
40+
- `connectionQueryMode` (optional, default: `auto`). One of `auto | nodes | edges | plain`. See [Connection Mode](connection-mode.md)
4141

4242
More options will come in future releases.
4343

0 commit comments

Comments
 (0)