Skip to content

Commit a04b481

Browse files
designatednerddesignatednerd
authored
Merge pull request #851 from apollographql/update/docs
Cleanup and improve existing docs, part 2
2 parents 25f860e + 04d9def commit a04b481

10 files changed

Lines changed: 253 additions & 200 deletions

File tree

‎docs/gatsby-config.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ module.exports = {
2828
'downloading-schema',
2929
'initialization',
3030
'fetching-queries',
31-
'fragments',
32-
'watching-queries',
3331
'mutations',
32+
'fragments',
33+
'caching',
3434
]
3535
}
3636
}

‎docs/source/api-reference.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ To generate docs for the main `Apollo` project, `cd` into the source root and ru
2626
```
2727
sourcedocs generate \
2828
--output-folder "docs/source/api/Apollo" \
29-
--link-beginning "../" \
3029
--link-ending "/" \
3130
-- \
3231
-scheme Apollo \
@@ -38,7 +37,6 @@ To generate docs for the `ApolloSQLite` project, `cd` into the source root and r
3837
```
3938
sourcedocs generate \
4039
--output-folder "docs/source/api/ApolloSQLite" \
41-
--link-beginning "../" \
4240
--link-ending "/" \
4341
-- \
4442
-scheme ApolloSQLite \
@@ -50,7 +48,6 @@ To generate for docs the `ApolloWebSocket` project, `cd` into the source root an
5048
```
5149
sourcedocs generate \
5250
--output-folder "docs/source/api/ApolloWebSocket" \
53-
--link-beginning "../" \
5451
--link-ending "/" \
5552
-- \
5653
-scheme ApolloWebSocket \

‎docs/source/api/Apollo/README.md‎

Lines changed: 87 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,107 @@
11
## Protocols
22

3-
- [ApolloClientProtocol](../protocols/ApolloClientProtocol/)
4-
- [Cancellable](../protocols/Cancellable/)
5-
- [GraphQLFragment](../protocols/GraphQLFragment/)
6-
- [GraphQLInputValue](../protocols/GraphQLInputValue/)
7-
- [GraphQLMapConvertible](../protocols/GraphQLMapConvertible/)
8-
- [GraphQLMutation](../protocols/GraphQLMutation/)
9-
- [GraphQLOperation](../protocols/GraphQLOperation/)
10-
- [GraphQLQuery](../protocols/GraphQLQuery/)
11-
- [GraphQLSelection](../protocols/GraphQLSelection/)
12-
- [GraphQLSelectionSet](../protocols/GraphQLSelectionSet/)
13-
- [GraphQLSubscription](../protocols/GraphQLSubscription/)
14-
- [HTTPNetworkTransportDelegate](../protocols/HTTPNetworkTransportDelegate/)
15-
- [HTTPNetworkTransportPreflightDelegate](../protocols/HTTPNetworkTransportPreflightDelegate/)
16-
- [HTTPNetworkTransportRetryDelegate](../protocols/HTTPNetworkTransportRetryDelegate/)
17-
- [HTTPNetworkTransportTaskCompletedDelegate](../protocols/HTTPNetworkTransportTaskCompletedDelegate/)
18-
- [JSONDecodable](../protocols/JSONDecodable/)
19-
- [JSONEncodable](../protocols/JSONEncodable/)
20-
- [Matchable](../protocols/Matchable/)
21-
- [NetworkTransport](../protocols/NetworkTransport/)
22-
- [NormalizedCache](../protocols/NormalizedCache/)
23-
- [RequestCreator](../protocols/RequestCreator/)
24-
- [UploadingNetworkTransport](../protocols/UploadingNetworkTransport/)
3+
- [ApolloClientProtocol](protocols/ApolloClientProtocol/)
4+
- [Cancellable](protocols/Cancellable/)
5+
- [GraphQLFragment](protocols/GraphQLFragment/)
6+
- [GraphQLInputValue](protocols/GraphQLInputValue/)
7+
- [GraphQLMapConvertible](protocols/GraphQLMapConvertible/)
8+
- [GraphQLMutation](protocols/GraphQLMutation/)
9+
- [GraphQLOperation](protocols/GraphQLOperation/)
10+
- [GraphQLQuery](protocols/GraphQLQuery/)
11+
- [GraphQLSelection](protocols/GraphQLSelection/)
12+
- [GraphQLSelectionSet](protocols/GraphQLSelectionSet/)
13+
- [GraphQLSubscription](protocols/GraphQLSubscription/)
14+
- [HTTPNetworkTransportDelegate](protocols/HTTPNetworkTransportDelegate/)
15+
- [HTTPNetworkTransportPreflightDelegate](protocols/HTTPNetworkTransportPreflightDelegate/)
16+
- [HTTPNetworkTransportRetryDelegate](protocols/HTTPNetworkTransportRetryDelegate/)
17+
- [HTTPNetworkTransportTaskCompletedDelegate](protocols/HTTPNetworkTransportTaskCompletedDelegate/)
18+
- [JSONDecodable](protocols/JSONDecodable/)
19+
- [JSONEncodable](protocols/JSONEncodable/)
20+
- [Matchable](protocols/Matchable/)
21+
- [NetworkTransport](protocols/NetworkTransport/)
22+
- [NormalizedCache](protocols/NormalizedCache/)
23+
- [RequestCreator](protocols/RequestCreator/)
24+
- [UploadingNetworkTransport](protocols/UploadingNetworkTransport/)
2525

2626
## Structs
2727

28-
- [ApolloRequestCreator](../structs/ApolloRequestCreator/)
29-
- [GraphQLBooleanCondition](../structs/GraphQLBooleanCondition/)
30-
- [GraphQLError](../structs/GraphQLError/)
31-
- [GraphQLField](../structs/GraphQLField/)
32-
- [GraphQLFile](../structs/GraphQLFile/)
33-
- [GraphQLFragmentSpread](../structs/GraphQLFragmentSpread/)
34-
- [GraphQLHTTPResponseError](../structs/GraphQLHTTPResponseError/)
35-
- [GraphQLResult](../structs/GraphQLResult/)
36-
- [GraphQLResultError](../structs/GraphQLResultError/)
37-
- [GraphQLTypeCase](../structs/GraphQLTypeCase/)
38-
- [GraphQLTypeCondition](../structs/GraphQLTypeCondition/)
39-
- [GraphQLVariable](../structs/GraphQLVariable/)
40-
- [Location](../structs/Location/)
41-
- [Record](../structs/Record/)
42-
- [RecordSet](../structs/RecordSet/)
43-
- [Reference](../structs/Reference/)
28+
- [ApolloRequestCreator](structs/ApolloRequestCreator/)
29+
- [GraphQLBooleanCondition](structs/GraphQLBooleanCondition/)
30+
- [GraphQLError](structs/GraphQLError/)
31+
- [GraphQLField](structs/GraphQLField/)
32+
- [GraphQLFile](structs/GraphQLFile/)
33+
- [GraphQLFragmentSpread](structs/GraphQLFragmentSpread/)
34+
- [GraphQLHTTPResponseError](structs/GraphQLHTTPResponseError/)
35+
- [GraphQLResult](structs/GraphQLResult/)
36+
- [GraphQLResultError](structs/GraphQLResultError/)
37+
- [GraphQLTypeCase](structs/GraphQLTypeCase/)
38+
- [GraphQLTypeCondition](structs/GraphQLTypeCondition/)
39+
- [GraphQLVariable](structs/GraphQLVariable/)
40+
- [Location](structs/Location/)
41+
- [Record](structs/Record/)
42+
- [RecordSet](structs/RecordSet/)
43+
- [Reference](structs/Reference/)
4444

4545
## Classes
4646

47-
- [ApolloClient](../classes/ApolloClient/)
48-
- [ApolloStore](../classes/ApolloStore/)
49-
- [EmptyCancellable](../classes/EmptyCancellable/)
50-
- [GraphQLQueryWatcher](../classes/GraphQLQueryWatcher/)
51-
- [GraphQLResponse](../classes/GraphQLResponse/)
52-
- [HTTPNetworkTransport](../classes/HTTPNetworkTransport/)
53-
- [InMemoryNormalizedCache](../classes/InMemoryNormalizedCache/)
54-
- [JSONSerializationFormat](../classes/JSONSerializationFormat/)
55-
- [MultipartFormData](../classes/MultipartFormData/)
56-
- [ReadTransaction](../classes/ReadTransaction/)
57-
- [ReadWriteTransaction](../classes/ReadWriteTransaction/)
47+
- [ApolloClient](classes/ApolloClient/)
48+
- [ApolloStore](classes/ApolloStore/)
49+
- [EmptyCancellable](classes/EmptyCancellable/)
50+
- [GraphQLQueryWatcher](classes/GraphQLQueryWatcher/)
51+
- [GraphQLResponse](classes/GraphQLResponse/)
52+
- [HTTPNetworkTransport](classes/HTTPNetworkTransport/)
53+
- [InMemoryNormalizedCache](classes/InMemoryNormalizedCache/)
54+
- [JSONSerializationFormat](classes/JSONSerializationFormat/)
55+
- [MultipartFormData](classes/MultipartFormData/)
56+
- [ReadTransaction](classes/ReadTransaction/)
57+
- [ReadWriteTransaction](classes/ReadWriteTransaction/)
5858

5959
## Enums
6060

61-
- [ApolloClientError](../enums/ApolloClientError/)
62-
- [CachePolicy](../enums/CachePolicy/)
63-
- [ErrorKind](../enums/ErrorKind/)
64-
- [GraphQLHTTPRequestError](../enums/GraphQLHTTPRequestError/)
65-
- [GraphQLOperationType](../enums/GraphQLOperationType/)
66-
- [GraphQLOutputType](../enums/GraphQLOutputType/)
67-
- [JSONDecodingError](../enums/JSONDecodingError/)
68-
- [Source](../enums/Source/)
61+
- [ApolloClientError](enums/ApolloClientError/)
62+
- [CachePolicy](enums/CachePolicy/)
63+
- [ErrorKind](enums/ErrorKind/)
64+
- [GraphQLHTTPRequestError](enums/GraphQLHTTPRequestError/)
65+
- [GraphQLOperationType](enums/GraphQLOperationType/)
66+
- [GraphQLOutputType](enums/GraphQLOutputType/)
67+
- [JSONDecodingError](enums/JSONDecodingError/)
68+
- [Source](enums/Source/)
6969

7070
## Extensions
7171

72-
- [ApolloClient](../extensions/ApolloClient/)
73-
- [Array](../extensions/Array/)
74-
- [Bool](../extensions/Bool/)
75-
- [Dictionary](../extensions/Dictionary/)
76-
- [DispatchQueue](../extensions/DispatchQueue/)
77-
- [Double](../extensions/Double/)
78-
- [Float](../extensions/Float/)
79-
- [GraphQLError](../extensions/GraphQLError/)
80-
- [GraphQLMapConvertible](../extensions/GraphQLMapConvertible/)
81-
- [GraphQLMutation](../extensions/GraphQLMutation/)
82-
- [GraphQLOperation](../extensions/GraphQLOperation/)
83-
- [GraphQLQuery](../extensions/GraphQLQuery/)
84-
- [GraphQLSelectionSet](../extensions/GraphQLSelectionSet/)
85-
- [GraphQLSubscription](../extensions/GraphQLSubscription/)
86-
- [GraphQLVariable](../extensions/GraphQLVariable/)
87-
- [HTTPNetworkTransport](../extensions/HTTPNetworkTransport/)
88-
- [Int](../extensions/Int/)
89-
- [JSONDecodingError](../extensions/JSONDecodingError/)
90-
- [JSONEncodable](../extensions/JSONEncodable/)
91-
- [Optional](../extensions/Optional/)
92-
- [RawRepresentable](../extensions/RawRepresentable/)
93-
- [Record](../extensions/Record/)
94-
- [RecordSet](../extensions/RecordSet/)
95-
- [Reference](../extensions/Reference/)
96-
- [RequestCreator](../extensions/RequestCreator/)
97-
- [String](../extensions/String/)
98-
- [URL](../extensions/URL/)
72+
- [ApolloClient](extensions/ApolloClient/)
73+
- [Array](extensions/Array/)
74+
- [Bool](extensions/Bool/)
75+
- [Dictionary](extensions/Dictionary/)
76+
- [DispatchQueue](extensions/DispatchQueue/)
77+
- [Double](extensions/Double/)
78+
- [Float](extensions/Float/)
79+
- [GraphQLError](extensions/GraphQLError/)
80+
- [GraphQLMapConvertible](extensions/GraphQLMapConvertible/)
81+
- [GraphQLMutation](extensions/GraphQLMutation/)
82+
- [GraphQLOperation](extensions/GraphQLOperation/)
83+
- [GraphQLQuery](extensions/GraphQLQuery/)
84+
- [GraphQLSelectionSet](extensions/GraphQLSelectionSet/)
85+
- [GraphQLSubscription](extensions/GraphQLSubscription/)
86+
- [GraphQLVariable](extensions/GraphQLVariable/)
87+
- [HTTPNetworkTransport](extensions/HTTPNetworkTransport/)
88+
- [Int](extensions/Int/)
89+
- [JSONDecodingError](extensions/JSONDecodingError/)
90+
- [JSONEncodable](extensions/JSONEncodable/)
91+
- [Optional](extensions/Optional/)
92+
- [RawRepresentable](extensions/RawRepresentable/)
93+
- [Record](extensions/Record/)
94+
- [RecordSet](extensions/RecordSet/)
95+
- [Reference](extensions/Reference/)
96+
- [RequestCreator](extensions/RequestCreator/)
97+
- [String](extensions/String/)
98+
- [URL](extensions/URL/)
9999

100100
## Methods
101101

102-
- [unzip(_:)](../methods/unzip(_:)/)
103-
- [unzip(_:)](../methods/unzip(_:)/)
104-
- [unzip(_:count:)](../methods/unzip(_:count:)/)
102+
- [unzip(_:)](methods/unzip(_:)/)
103+
- [unzip(_:)](methods/unzip(_:)/)
104+
- [unzip(_:count:)](methods/unzip(_:count:)/)
105105

106106
# Reference Documentation
107107
This reference documentation was generated with

‎docs/source/api/ApolloSQLite/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11

22
## Classes
33

4-
- [SQLiteNormalizedCache](../classes/SQLiteNormalizedCache/)
4+
- [SQLiteNormalizedCache](classes/SQLiteNormalizedCache/)
55

66
## Enums
77

8-
- [SQLiteNormalizedCacheError](../enums/SQLiteNormalizedCacheError/)
8+
- [SQLiteNormalizedCacheError](enums/SQLiteNormalizedCacheError/)
99

1010
## Extensions
1111

12-
- [SQLiteNormalizedCache](../extensions/SQLiteNormalizedCache/)
12+
- [SQLiteNormalizedCache](extensions/SQLiteNormalizedCache/)
1313

1414
# Reference Documentation
1515
This reference documentation was generated with

‎docs/source/api/ApolloWebSocket/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
## Protocols
22

3-
- [ApolloWebSocketClient](../protocols/ApolloWebSocketClient/)
4-
- [WebSocketTransportDelegate](../protocols/WebSocketTransportDelegate/)
3+
- [ApolloWebSocketClient](protocols/ApolloWebSocketClient/)
4+
- [WebSocketTransportDelegate](protocols/WebSocketTransportDelegate/)
55

66
## Structs
77

8-
- [WebSocketError](../structs/WebSocketError/)
8+
- [WebSocketError](structs/WebSocketError/)
99

1010
## Classes
1111

12-
- [ApolloWebSocket](../classes/ApolloWebSocket/)
13-
- [SplitNetworkTransport](../classes/SplitNetworkTransport/)
14-
- [WebSocketTransport](../classes/WebSocketTransport/)
12+
- [ApolloWebSocket](classes/ApolloWebSocket/)
13+
- [SplitNetworkTransport](classes/SplitNetworkTransport/)
14+
- [WebSocketTransport](classes/WebSocketTransport/)
1515

1616
## Enums
1717

18-
- [ErrorKind](../enums/ErrorKind/)
18+
- [ErrorKind](enums/ErrorKind/)
1919

2020
## Extensions
2121

22-
- [SplitNetworkTransport](../extensions/SplitNetworkTransport/)
23-
- [WebSocketTransport](../extensions/WebSocketTransport/)
24-
- [WebSocketTransportDelegate](../extensions/WebSocketTransportDelegate/)
22+
- [SplitNetworkTransport](extensions/SplitNetworkTransport/)
23+
- [WebSocketTransport](extensions/WebSocketTransport/)
24+
- [WebSocketTransportDelegate](extensions/WebSocketTransportDelegate/)
2525

2626
# Reference Documentation
2727
This reference documentation was generated with

0 commit comments

Comments
 (0)
⚡