Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix documentation typos and formatting in address, types and contribution files #1788

Merged
merged 6 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions site/docs/pages/api/types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,10 @@ type GetMintDetailsParams = {
```

## `GetMintDetailsResponse`
type GetMintDetailsResponse = MintDetails | APIError;

```ts
type GetMintDetailsResponse = MintDetails | APIError;
```

## `BuildMintTransactionParams`

Expand All @@ -138,4 +140,4 @@ type BuildMintTransactionParams = {

```ts
type BuildMintTransactionResponse = MintTransaction | APIError;
```
```
6 changes: 3 additions & 3 deletions site/docs/pages/guides/contribution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In this guide, you will learn how to:
- [Set up this project](#setup)
- [Navigate the codebase](#codebase)
- [Accomplish various workflows](#workflows)
- [Submit feature request](#feature-request)
- [Submit a feature request](#feature-request)

## Setup

Expand Down Expand Up @@ -109,7 +109,7 @@ If the coverage drops below 100%, look at the coverage report generated by the a
open coverage/index.html
```

### Testing UI with hotreload
### Testing UI with hot reload

We use this doc site to test UI changes.

Expand Down Expand Up @@ -144,7 +144,7 @@ To update the change log, run:
yarn changeset
```

Select `minor` and use the following format for the summary:
Select `minor` and use:
dschlabach marked this conversation as resolved.
Show resolved Hide resolved

```markdown
- **feat**: feature update information. By @your-github-id #XX (XX is the PR number)
Expand Down
4 changes: 2 additions & 2 deletions site/docs/pages/identity/address.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import App from '../../components/App';

# `<Address />`

The `Address` component is used to render shorten user account address.
The `Address` component is used to render shortened user account address.
dschlabach marked this conversation as resolved.
Show resolved Hide resolved

## Usage

Expand All @@ -25,7 +25,7 @@ Set `isSliced` to false, to display the full address:

```tsx twoslash
import { Address } from '@coinbase/onchainkit/identity';
<Address address="0x02feeb0AdE57b6adEEdE5A4EEea6Cf8c21BeB6B1" isSliced={false}/> // [!code focus]
<Address address="0x02feeb0AdE57b6adEEdE5A4EEea6Cf8c21BeB6B1" isSliced={false} /> // [!code focus]
```

<App>
Expand Down