Skip to content

docs: fix incorrect paths and add missing demos to README#115

Open
skyc1e wants to merge 1 commit intobase:masterfrom
skyc1e:fix/readme-paths-and-missing-demos
Open

docs: fix incorrect paths and add missing demos to README#115
skyc1e wants to merge 1 commit intobase:masterfrom
skyc1e:fix/readme-paths-and-missing-demos

Conversation

@skyc1e
Copy link
Copy Markdown

@skyc1e skyc1e commented Mar 24, 2026

Description

The main README had several issues that would confuse newcomers trying to navigate the repo:

Incorrect paths (all MiniKit demos):

  • Table referenced minikit/... but actual directories are mini-apps/workshops/... and mini-apps/templates/minikit/...
  • "Full Mini App Demo" pointed to minikit/mini-app-full-demo/ which doesn't exist

8 missing demos not listed in the table:

  • auto-sub-accounts
  • base-account-rainbow-template
  • base-account-reown
  • base-account-thirdweb-template
  • base-account-wagmi-template
  • new-mini-app-quickstart
  • vite-mini
  • Full Mini App Demo (Farcaster SDK variant)

Wrong clone path in quickstart:

  • new-mini-app-quickstart/README.md told users to cd demos/minikit/waitlist-mini-app-qs which doesn't exist

Files changed

  • README.md — fixed all paths, added missing demos
  • mini-apps/templates/minikit/new-mini-app-quickstart/README.md — fixed clone path

The main README table had wrong paths for all MiniKit demos (referenced
`minikit/` instead of actual `mini-apps/workshops/` and
`mini-apps/templates/minikit/` directories). Also added 8 demos that
were missing from the table entirely.

Also fixed the clone path in new-mini-app-quickstart README which
pointed to a non-existent `demos/minikit/waitlist-mini-app-qs` directory.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant