Skip to content

Fix/sidebar foundry links #2327

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion apps/base-docs/docs/pages/builderkits/minikit/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: Easiest way to build Mini Apps on Base
src="/images/minikit/minikit-cli.gif"
height="364"/>

MiniKit is easiest way to build Mini Apps on Base, allowing developers to easily build applications without needing to know the details of the SDK implementation. It integrates seamlessly with OnchainKit components and provides Coinbase Wallet-specific hooks.
MiniKit is the easiest way to build Mini Apps on Base, allowing developers to easily build applications without needing to know the details of the SDK implementation. It integrates seamlessly with OnchainKit components and provides Coinbase Wallet-specific hooks.

## Why MiniKit?

Expand Down
14 changes: 7 additions & 7 deletions apps/base-docs/docs/pages/builderkits/minikit/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MiniKit Quickstart

This guide shows you how to get started with MiniKit, the easist way to build mini apps on Base! It can also be used to update an exisitng standalone app to a mini app. We'll start by setting up the template project with the CLI tool and then explore both built-in and additional features of MiniKit.
This guide shows you how to get started with MiniKit, the easiest way to build mini apps on Base! It can also be used to update an existing standalone app to a mini app. We'll start by setting up the template project with the CLI tool and then explore both built-in and additional features of MiniKit.

## Prerequisites

Expand Down Expand Up @@ -110,7 +110,7 @@ The template comes with several pre-implemented features. Let's explore where th

### MiniKitProvider

The `MiniKitProvider` is set up in your `providers.tsx` file. It wraps your application to handle initialization, events, and automatically applie client safeAreaInsets to ensure your app doesn't overlap parent application elements.
The `MiniKitProvider` is set up in your `providers.tsx` file. It wraps your application to handle initialization, events, and automatically applies client safeAreaInsets to ensure your app doesn't overlap parent application elements.

```tsx [app/providers.tsx]
import { MiniKitProvider } from '@coinbase/onchainkit/minikit';
Expand All @@ -135,7 +135,7 @@ export function Providers(props: { children: ReactNode }) {
}
```

The MiniKitProvider also sets up your wagmi and react-query providers automatically, elimintaing that initial setup work.
The MiniKitProvider also sets up your wagmi and react-query providers automatically, eliminating that initial setup work.

### useMiniKit

Expand Down Expand Up @@ -170,7 +170,7 @@ Enter `y` to proceed with the setup and your browser will open to the following
height="364"
/>

The wallet that you connect must be your Farcaster custody wallet. You can import this wallet to your prefered wallet using the recovery phrase. You can find your recovery phrase in the Warpcast app under Settings -> Advanced -> Farcster recovery phrase.
The wallet that you connect must be your Farcaster custody wallet. You can import this wallet to your prefered wallet using the recovery phrase. You can find your recovery phrase in the Warpcast app under Settings -> Advanced -> Farcaster recovery phrase.

Once connected, add the vercel url and sign the manifest. This will automatically update your .env variables locally, but we'll need to update Vercel's .env variables.

Expand Down Expand Up @@ -229,7 +229,7 @@ const openUrl = useOpenUrl()
</footer>
```

Now that we've reviewed the MiniKit teamplate and the functionality already implemented, lets add some additional MiniKit features.
Now that we've reviewed the MiniKit template and the functionality already implemented, lets add some additional MiniKit features.

## Additional MiniKit Features

Expand Down Expand Up @@ -280,7 +280,7 @@ usePrimaryButton(
)
```

You'll notice that adding the Primary button takes up space at the bottom of the frame, which causes the "BUILT ON BASE WITH MINIKIT" button to move upwards and overlap with the contorls.
You'll notice that adding the Primary button takes up space at the bottom of the frame, which causes the "BUILT ON BASE WITH MINIKIT" button to move upwards and overlap with the controls.
We can quickly fix that by changing the text to "BUILT WITH MINIKIT" and removing the `ml-4` style in the `className` of the `<button>`

### `useViewProfile`
Expand Down Expand Up @@ -310,7 +310,7 @@ const handleViewProfile = () => {

### `useNotification`

One of the major benefits of mini apps is that you can send notifications to your users through their socail app.
One of the major benefits of mini apps is that you can send notifications to your users through their social app.

Recall the token and url we saved in the [useAddFrame section](docs.base.org/builderkits/minikit/quickstart#useaddframe)? We'll use those now to send a user a notification. In this guide, we'll simply send a test notification unrelated to the game activity.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,18 @@ declare module 'wagmi' {

This configuration sets up the wagmi project to connect to the Base and BaseSepolia networks, utilizing Coinbase Wallet and other connectors.

Now well create a component to display the Basenames associated with an address.
Now we'll create a component to display the Basenames associated with an address.

:::tip[Use Base as your chain]
Ensure Chain is Set to Base Be sure to set the `chain={base}` parameter; otherwise, it will default to ENS (Ethereum Name Service).
Ensure Chain is Set to Base. Be sure to set the `chain={base}` parameter; otherwise, it will default to ENS (Ethereum Name Service).
:::

```typescript filename="src/components/basename.tsx"
'use client';
import React from 'react';
('use client');
import React from 'react';
import { Avatar, Identity, Name, Address } from '@coinbase/onchainkit/identity';
import { base } from 'viem/chains';

interface DisplayBasenameProps {
address: `0x${string}`
address: `0x${string}`;
}
4 changes: 2 additions & 2 deletions apps/base-docs/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1464,11 +1464,11 @@ export const sidebar: Sidebar = [
items: [
{
text: 'Introduction to Foundry ↗',
link: 'https://docs.base.org/tutorials/intro-to-foundry-setup',
link: '/intro-to-foundry-setup',
},
{
text: 'Testing Smart Contracts ↗',
link: 'https://docs.base.org/tutorials/intro-to-foundry-testing',
link: '/intro-to-foundry-testing',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links aren't valid, to test, they should work when you prepend https://docs.base.org/

e.g.

https://docs.base.org/intro-to-foundry-testing (doesn't work)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback! I’ll follow up with a fix and update the PR accordingly

},
],
},
Expand Down
Loading