Skip to content

Commit

Permalink
docs: fix links (#614)
Browse files Browse the repository at this point in the history
  • Loading branch information
dcdunkan authored Jul 18, 2024
1 parent 8ebf31c commit 31d0ba9
Show file tree
Hide file tree
Showing 12 changed files with 36 additions and 36 deletions.
4 changes: 2 additions & 2 deletions src/bot.ts
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ export class Bot<
* your bot will handle.
*
* If you're writing a library on top of grammY, check out the
* [documentation](https://grammy.dev/plugins/runner.html) of the runner
* [documentation](https://grammy.dev/plugins/runner) of the runner
* plugin for an example that uses this method.
*
* @param update An update from the Telegram Bot API
Expand Down Expand Up @@ -412,7 +412,7 @@ a known bot info object.",
* will impact the responsiveness negatively, so it makes sense to use the
* `@grammyjs/runner` package even if you receive much fewer messages. If
* you worry about how much load your bot can handle, check out the grammY
* [documentation](https://grammy.dev/advanced/scaling.html) about scaling
* [documentation](https://grammy.dev/advanced/scaling) about scaling
* up.
*
* @param options Options to use for simple long polling
Expand Down
12 changes: 6 additions & 6 deletions src/composer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export interface MiddlewareObj<C extends Context = Context> {
* Middleware is an extremely powerful concept and this short explanation only
* scratched the surface of what is possible with grammY. If you want to know
* more advanced things about middleware, check out the
* [documentation](https://grammy.dev/guide/middleware.html) on the website.
* [documentation](https://grammy.dev/guide/middleware) on the website.
*/
export type Middleware<C extends Context = Context> =
| MiddlewareFn<C>
Expand Down Expand Up @@ -183,7 +183,7 @@ export async function run<C extends Context>(
*
* On the other hand, if you want to dig deeper into how grammY implements
* middleware, check out the
* [documentation](https://grammy.dev/advanced/middleware.html) on the website.
* [documentation](https://grammy.dev/advanced/middleware) on the website.
*/
export class Composer<C extends Context> implements MiddlewareObj<C> {
private handler: MiddlewareFn<C>;
Expand Down Expand Up @@ -217,7 +217,7 @@ export class Composer<C extends Context> implements MiddlewareObj<C> {
*
* This method returns a new instance of composer. The returned instance can
* be further extended, and all changes will be regarded here. Confer the
* [documentation](https://grammy.dev/advanced/middleware.html) on the
* [documentation](https://grammy.dev/advanced/middleware) on the
* website if you want to know more about how the middleware system in
* grammY works, especially when it comes to chaining the method calls
* (`use( ... ).use( ... ).use( ... )`).
Expand Down Expand Up @@ -258,7 +258,7 @@ export class Composer<C extends Context> implements MiddlewareObj<C> {
*
* You can use autocomplete in VS Code to see all available filter queries.
* Check out the
* [documentation](https://grammy.dev/guide/filter-queries.html) on the
* [documentation](https://grammy.dev/guide/filter-queries) on the
* website to learn more about filter queries in grammY.
*
* It is possible to pass multiple filter queries in an array, i.e.
Expand Down Expand Up @@ -445,7 +445,7 @@ export class Composer<C extends Context> implements MiddlewareObj<C> {
* // Groups and supergroups only
* bot.chatType(["group", "supergroup"], ctx => { ... });
* ```
* [Remember](https://grammy.dev/guide/context.html#shortcuts) also that you
* [Remember](https://grammy.dev/guide/context#shortcuts) also that you
* can access the chat type via `ctx.chat.type`.
*
* @param chatType The chat type
Expand Down Expand Up @@ -896,7 +896,7 @@ export class Composer<C extends Context> implements MiddlewareObj<C> {
* ```
*
* Check out the
* [documentation](https://grammy.dev/guide/errors.html#error-boundaries) on
* [documentation](https://grammy.dev/guide/errors#error-boundaries) on
* the website to learn more about error boundaries.
*
* @param errorHandler The error handler to use
Expand Down
2 changes: 1 addition & 1 deletion src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ const checker: StaticHas = {
* methods to keep information about how a regular expression was matched.
*
* Read up about middleware on the
* [website](https://grammy.dev/guide/context.html) if you want to know more
* [website](https://grammy.dev/guide/context) if you want to know more
* about the powerful opportunities that lie in context objects, and about how
* grammY implements them.
*/
Expand Down
14 changes: 7 additions & 7 deletions src/convenience/keyboard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ type KeyboardSource = KeyboardButtonSource[][] | Keyboard;
* ```
*
* Be sure to check out the
* [documentation](https://grammy.dev/plugins/keyboard.html#custom-keyboards) on
* [documentation](https://grammy.dev/plugins/keyboard#custom-keyboards) on
* custom keyboards in grammY.
*/
export class Keyboard {
Expand Down Expand Up @@ -287,7 +287,7 @@ export class Keyboard {
}
/**
* Make the current keyboard persistent. See
* https://grammy.dev/plugins/keyboard.html#persistent-keyboards for more
* https://grammy.dev/plugins/keyboard#persistent-keyboards for more
* details.
*
* Keyboards are not persistent by default, use this function to enable it
Expand All @@ -302,7 +302,7 @@ export class Keyboard {
}
/**
* Make the current keyboard selective. See
* https://grammy.dev/plugins/keyboard.html#selectively-send-custom-keyboards
* https://grammy.dev/plugins/keyboard#selectively-send-custom-keyboards
* for more details.
*
* Keyboards are non-selective by default, use this function to enable it
Expand All @@ -317,7 +317,7 @@ export class Keyboard {
}
/**
* Make the current keyboard one-time. See
* https://grammy.dev/plugins/keyboard.html#one-time-custom-keyboards for
* https://grammy.dev/plugins/keyboard#one-time-custom-keyboards for
* more details.
*
* Keyboards are non-one-time by default, use this function to enable it
Expand All @@ -332,7 +332,7 @@ export class Keyboard {
}
/**
* Make the current keyboard resized. See
* https://grammy.dev/plugins/keyboard.html#resize-custom-keyboard for more
* https://grammy.dev/plugins/keyboard#resize-custom-keyboard for more
* details.
*
* Keyboards are non-resized by default, use this function to enable it
Expand All @@ -347,7 +347,7 @@ export class Keyboard {
}
/**
* Set the current keyboard's input field placeholder. See
* https://grammy.dev/plugins/keyboard.html#input-field-placeholder for more
* https://grammy.dev/plugins/keyboard#input-field-placeholder for more
* details.
*
* @param value The placeholder text
Expand Down Expand Up @@ -513,7 +513,7 @@ type InlineKeyboardSource = InlineKeyboardButton[][] | InlineKeyboard;
* ```
*
* Be sure to to check the
* [documentation](https://grammy.dev/plugins/keyboard.html#inline-keyboards) on
* [documentation](https://grammy.dev/plugins/keyboard#inline-keyboards) on
* inline keyboards in grammY.
*/
export class InlineKeyboard {
Expand Down
16 changes: 8 additions & 8 deletions src/convenience/session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ type MaybePromise<T> = Promise<T> | T;
* Session middleware will load the session data of a specific chat from your
* storage solution, and make it available to you on the context object. Check
* out the
* [documentation](https://doc.deno.land/https://deno.land/x/grammy/mod.ts/~/session)
* [documentation](https://grammy.dev/ref/core/session)
* on session middleware to know more, and read the section about sessions on
* the [website](https://grammy.dev/plugins/session.html).
* the [website](https://grammy.dev/plugins/session).
*/
export interface SessionFlavor<S> {
/**
Expand All @@ -42,10 +42,10 @@ export interface SessionFlavor<S> {
* object. Once you access `ctx.session`, the storage will be queried and the
* session data becomes available. If you access `ctx.session` again for the
* same context object, the cached value will be used. Check out the
* [documentation](https://doc.deno.land/https://deno.land/x/grammy/mod.ts/~/lazySession)
* [documentation](https://grammy.dev/ref/core/lazysession)
* on lazy session middleware to know more, and read the section about lazy
* sessions on the
* [website](https://grammy.dev/plugins/session.html#lazy-sessions).
* [website](https://grammy.dev/plugins/session#lazy-sessions).
*/
export interface LazySessionFlavor<S> {
/**
Expand Down Expand Up @@ -124,7 +124,7 @@ export interface SessionOptions<S, C extends Context = Context> {
* This option lets you generate your own session keys per context object.
* The session key determines how to map the different session objects to
* your chats and users. Check out the
* [documentation](https://grammy.dev/plugins/session.html#how-to-use-sessions)
* [documentation](https://grammy.dev/plugins/session#how-to-use-sessions)
* on the website about how to use session middleware to know how session
* keys are used.
*
Expand All @@ -139,7 +139,7 @@ export interface SessionOptions<S, C extends Context = Context> {
* delete access to the session middleware.
*
* Consider using a [known storage
* adapter](https://grammy.dev/plugins/session.html#known-storage-adapters)
* adapter](https://grammy.dev/plugins/session#known-storage-adapters)
* instead of rolling your own implementation of this.
*
* The default implementation will store session in memory. The data will be
Expand Down Expand Up @@ -206,7 +206,7 @@ type MultiSessionOptionsRecord<
* You can delete the session data by setting `ctx.session` to `null` or
* `undefined`.
*
* Check out the [documentation](https://grammy.dev/plugins/session.html) on the
* Check out the [documentation](https://grammy.dev/plugins/session) on the
* website to know more about how sessions work in grammY.
*
* @param options Optional configuration to pass to the session middleware
Expand Down Expand Up @@ -291,7 +291,7 @@ function strictMultiSession<S, C extends Context>(
* ```
*
* Check out the
* [documentation](https://grammy.dev/plugins/session.html#lazy-sessions) on the
* [documentation](https://grammy.dev/plugins/session#lazy-sessions) on the
* website to know more about how lazy sessions work in grammY.
*
* @param options Optional configuration to pass to the session middleware
Expand Down
2 changes: 1 addition & 1 deletion src/convenience/webhook.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ type ResolveName<A extends FrameworkAdapter | AdapterNames> = A extends
* ```
*
* Confer the grammY
* [documentation](https://grammy.dev/guide/deployment-types.html) to read more
* [documentation](https://grammy.dev/guide/deployment-types) to read more
* about how to run your bot with webhooks.
*
* @param bot The bot for which to create a callback
Expand Down
2 changes: 1 addition & 1 deletion src/core/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ type ApiCallResult<M extends Methods<R>, R extends RawApi> = R[M] extends
* implement rate limiting or other things against the Telegram Bot API.
*
* Confer the grammY
* [documentation](https://grammy.dev/advanced/transformers.html) to read more
* [documentation](https://grammy.dev/advanced/transformers) to read more
* about how to use transformers.
*/
export type Transformer<R extends RawApi = RawApi> = <M extends Methods<R>>(
Expand Down
2 changes: 1 addition & 1 deletion src/core/error.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ export function toGrammyError(
* request failed.
*
* If an [API transformer
* function](https://grammy.dev/advanced/transformers.html) throws an error,
* function](https://grammy.dev/advanced/transformers) throws an error,
* grammY will regard this as if the network request failed. The contained error
* will then be the error that was thrown by the transformer function.
*/
Expand Down
6 changes: 3 additions & 3 deletions src/filter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ const filterQueryCache = new Map<string, (ctx: Context) => boolean>();
* ```
*
* Check out the
* [documentation](https://doc.deno.land/https://deno.land/x/grammy/mod.ts/~/Composer)
* [documentation](https://grammy.dev/ref/core/composer#on)
* of `bot.on` for examples. In addition, the
* [website](https://grammy.dev/guide/filter-queries.html) contains more
* [website](https://grammy.dev/guide/filter-queries) contains more
* information about how filter queries work in grammY.
*
* @param filter A filter query or an array of filter queries
Expand Down Expand Up @@ -424,7 +424,7 @@ type ComputeFilterQueryList = InjectShortcuts;
/**
* Represents a filter query that can be passed to `bot.on`. There are three
* different kinds of filter queries: Level 1, Level 2, and Level 3. Check out
* the [website](https://grammy.dev/guide/filter-queries.html) to read about how
* the [website](https://grammy.dev/guide/filter-queries) to read about how
* filter queries work in grammY, and how to use them.
*
* Here are three brief examples:
Expand Down
4 changes: 2 additions & 2 deletions src/types.deno.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ interface URLLike {
// === InputFile handling and File augmenting
/**
* An `InputFile` wraps a number of different sources for [sending
* files](https://grammy.dev/guide/files.html#uploading-your-own-file).
* files](https://grammy.dev/guide/files#uploading-your-own-files).
*
* It corresponds to the `InputFile` type in the [Telegram Bot API
* Reference](https://core.telegram.org/bots/api#inputfile).
Expand All @@ -48,7 +48,7 @@ export class InputFile {
* Optional name of the constructed `InputFile` instance.
*
* Check out the
* [documentation](https://grammy.dev/guide/files.html#uploading-your-own-file)
* [documentation](https://grammy.dev/guide/files#uploading-your-own-files)
* on sending files with `InputFile`.
*/
public readonly filename?: string;
Expand Down
4 changes: 2 additions & 2 deletions src/types.node.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ interface URLLike {
// === InputFile handling and File augmenting
/**
* An `InputFile` wraps a number of different sources for [sending
* files](https://grammy.dev/guide/files.html#uploading-your-own-file).
* files](https://grammy.dev/guide/files#uploading-your-own-files).
*
* It corresponds to the `InputFile` type in the [Telegram Bot API
* Reference](https://core.telegram.org/bots/api#inputfile).
Expand All @@ -49,7 +49,7 @@ export class InputFile {
* Optional name of the constructed `InputFile` instance.
*
* Check out the
* [documentation](https://grammy.dev/guide/files.html#uploading-your-own-file)
* [documentation](https://grammy.dev/guide/files#uploading-your-own-files)
* on sending files with `InputFile`.
*/
public readonly filename?: string;
Expand Down
4 changes: 2 additions & 2 deletions src/types.web.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ interface URLLike {
// === InputFile handling and File augmenting
/**
* An `InputFile` wraps a number of different sources for [sending
* files](https://grammy.dev/guide/files.html#uploading-your-own-file).
* files](https://grammy.dev/guide/files#uploading-your-own-files).
*
* It corresponds to the `InputFile` type in the [Telegram Bot API
* Reference](https://core.telegram.org/bots/api#inputfile).
Expand All @@ -42,7 +42,7 @@ export class InputFile {
* Optional name of the constructed `InputFile` instance.
*
* Check out the
* [documentation](https://grammy.dev/guide/files.html#uploading-your-own-file)
* [documentation](https://grammy.dev/guide/files#uploading-your-own-files)
* on sending files with `InputFile`.
*/
public readonly filename?: string;
Expand Down

0 comments on commit 31d0ba9

Please sign in to comment.