Skip to content
This repository has been archived by the owner on Jan 20, 2025. It is now read-only.

Commit

Permalink
fix links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pilcrowonpaper committed Feb 7, 2024
1 parent d921496 commit 5c98b1d
Show file tree
Hide file tree
Showing 13 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/Base32Encoding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Base32Encoding"

# `Base32Encoding`

Radix 32 encoding/decoding scheme. Characters are case sensitive. Use [`base32`](/encoding/base32) or [`base32hex`](/encoding/base32hex) for Base 32 encoding based on [RFC 4648](https://rfc-editor.org/rfc/rfc4648.html).
Radix 32 encoding/decoding scheme. Characters are case sensitive. Use [`base32`](/reference/encoding/base32) or [`base32hex`](/reference/encoding/base32hex) for Base 32 encoding based on [RFC 4648](https://rfc-editor.org/rfc/rfc4648.html).

## Constructor

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/Base64Encoding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: "Base64Encoding"

# `Base64Encoding`

Radix 64 encoding/decoding scheme. Characters are case sensitive. Use [`base64`](/encoding/base64) or [`base64url`](/encoding/base64url) for Base 64 encoding based on [RFC 4648](https://rfc-editor.org/rfc/rfc4648.html).
Radix 64 encoding/decoding scheme. Characters are case sensitive. Use [`base64`](/reference/encoding/base64) or [`base64url`](/reference/encoding/base64url) for Base 64 encoding based on [RFC 4648](https://rfc-editor.org/rfc/rfc4648.html).

## Constructor

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/base32.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: "base32"

# `base32`

Implements Base 32 based on [RFC 4648 §6](https://datatracker.ietf.org/doc/html/rfc4648#section-6) with [`Base32Encoding`](/encoding/Base32Encoding).
Implements Base 32 based on [RFC 4648 §6](https://datatracker.ietf.org/doc/html/rfc4648#section-6) with [`Base32Encoding`](/reference/encoding/Base32Encoding).
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/base32hex.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: "base32hex"

# `base32hex`

Implements Base 32 with extended hex alphabet based on [RFC 4648 §7](https://datatracker.ietf.org/doc/html/rfc4648#section-7) with [`Base32Encoding`](/encoding/Base32Encoding).
Implements Base 32 with extended hex alphabet based on [RFC 4648 §7](https://datatracker.ietf.org/doc/html/rfc4648#section-7) with [`Base32Encoding`](/reference/encoding/Base32Encoding).
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/base64.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: "base64"

# `base64`

Implements Base 64 encoding based on [RFC 4648 §4](https://datatracker.ietf.org/doc/html/rfc4648#section-4) with [`Base64Encoding`](/encoding/Base64Encoding).
Implements Base 64 encoding based on [RFC 4648 §4](https://datatracker.ietf.org/doc/html/rfc4648#section-4) with [`Base64Encoding`](/reference/encoding/Base64Encoding).
2 changes: 1 addition & 1 deletion docs/pages/reference/encoding/base64url.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: "base64url"

# `base64url`

Implements Base 64 URL encoding based on [RFC 4648 §5](https://datatracker.ietf.org/doc/html/rfc4648#section-5) with [`Base64Encoding`](/encoding/Base64Encoding).
Implements Base 64 URL encoding based on [RFC 4648 §5](https://datatracker.ietf.org/doc/html/rfc4648#section-5) with [`Base64Encoding`](/reference/encoding/Base64Encoding).
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/decodeBase32.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "decodeBase32()"
---

**Deprecated - Use [`base32`](/encoding/base32) instead.**

# `decodeBase32()`

**Deprecated - Use [`base32`](/reference/encoding/base32) instead.**

Decodes base32 strings. This does not check the length and ignores padding. Use [`encodeBase32()`](/reference/encoding/encodeBase32) to encode into base32 strings.

## Definition
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/decodeBase64.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "decodeBase64()"
---

**Deprecated - Use [`base64`](/encoding/base64) instead.**

# `decodeBase64()`

**Deprecated - Use [`base64`](/reference/encoding/base64) instead.**

Decodes base64 strings. This does not check the length and ignores padding. Use [`encodeBase64()`](/reference/encoding/encodeBase64) to encode into base64 strings.

## Definition
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/decodeBase64url.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "decodeBase64url()"
---

**Deprecated - Use [`base64url`](/encoding/base64url) instead.**

# `decodeBase64url()`

**Deprecated - Use [`base64url`](/reference/encoding/base64url) instead.**

Decodes base64 URL strings. Use [`encodeBase64url()`](/reference/encoding/encodeBase64url) to encode into base64 URL strings.

## Definition
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/encodeBase32.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "encodeBase32()"
---

**Deprecated - Use [`base32`](/encoding/base32) instead.**

# `encodeBase32()`

**Deprecated - Use [`base32`](/reference/encoding/base32) instead.**

Encodes data into base32 string. Use [`decodeBase32()`](/reference/encoding/decodeBase32) to decode base32 strings.

## Definition
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/encodeBase64.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "encodeBase64()"
---

**Deprecated - Use [`base64`](/encoding/base64) instead.**

# `encodeBase64()`

**Deprecated - Use [`base64`](/reference/encoding/base64) instead.**

Encodes data into base64 string. Use [`decodeBase64()`](/reference/encoding/decodeBase64) to decode base64 strings.

## Definition
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/reference/encoding/encodeBase64url.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "encodeBase64url()"
---

**Deprecated - Use [`base64url`](/encoding/base64url) instead.**

# `encodeBase64url()`

**Deprecated - Use [`base64url`](/reference/encoding/base64url) instead.**

Encodes data into base64 URL string. Use [`decodeBase64url()`](/reference/encoding/decodeBase64url) to decode base64 URL strings.

## Definition
Expand Down
12 changes: 6 additions & 6 deletions docs/pages/reference/encoding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ title: "oslo/encoding"

Provides utilities for encoding and decoding with various formats.

- [`base32`](/encoding/base32)
- [`base32hex`](/encoding/base32hex)
- [`Base32Encoding`](/encoding/Base32Encoding)
- [`base64`](/encoding/base64url)
- [`base64url`](/encoding/base64url)
- [`Base64Encoding`](/encoding/Base64Encoding)
- [`base32`](/reference/encoding/base32)
- [`base32hex`](/reference/encoding/base32hex)
- [`Base32Encoding`](/reference/encoding/Base32Encoding)
- [`base64`](/reference/encoding/base64url)
- [`base64url`](/reference/encoding/base64url)
- [`Base64Encoding`](/reference/encoding/Base64Encoding)
- [`decodeHex()`](/reference/encoding/decodeHex)
- [`encodeHex()`](/reference/encoding/encodeHex)
- [`encodeBase32()`](/reference/encoding/encodeBase32) (_deprecated_)
Expand Down

0 comments on commit 5c98b1d

Please sign in to comment.