Skip to content

Commit a54a137

Browse files
JakeChampionJake Champion
andcommitted
fix: Fix our api website implementation (#229)
The version of typedoc we are using no longer has the minimal theme as it is very out of date and buggy. I've installed a new theme which is similar to minimal but offers some extra features such as search. I've also fixed some broken internal linking we had in the api docs Co-authored-by: Jake Champion <[email protected]>
1 parent ea5b059 commit a54a137

File tree

4 files changed

+350
-95
lines changed

4 files changed

+350
-95
lines changed

sdk/js-compute/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ export declare class Dictionary {
166166
*
167167
* Can be retrieved for the incoming request's client IP address using the
168168
* {@linkcode ClientInfo#geo} accessor, and for arbitrary addresses using
169-
* {@linkcode fastly.getGeolocationForIpAddress}.
169+
* {@linkcode Fastly.getGeolocationForIpAddress}.
170170
*/
171171
export declare interface Geolocation {
172172
/**
@@ -515,7 +515,7 @@ export declare class TextDecoder {
515515
* Simple interface for logging to
516516
* [third party logging providers](https://developer.fastly.com/learning/integrations/logging)
517517
*
518-
* Instances of Logger for specific endpoints can be created using {@linkcode fastly.getLogger}.
518+
* Instances of Logger for specific endpoints can be created using {@linkcode Fastly.getLogger}.
519519
*/
520520
export declare interface Logger {
521521
/**
@@ -891,7 +891,7 @@ type ReadableStreamDefaultReadResult<T> = ReadableStreamDefaultReadValueResult<T
891891
export interface ReadableWritablePair<R = any, W = any> {
892892
readable: ReadableStream<R>;
893893
/**
894-
* Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other { writable, readable } pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use.
894+
* Provides a convenient, chainable way of piping this readable stream through a transform stream (or any other \{ writable, readable \} pair). It simply pipes the stream into the writable side of the supplied pair, and returns the readable side for further use.
895895
*
896896
* Piping a stream will lock it for the duration of the pipe, preventing any other consumer from acquiring a reader.
897897
*/

0 commit comments

Comments
 (0)