Skip to content

Overhaul Mini Apps IA and scaffold new docs | WIP #207

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ericbrown99
Copy link
Collaborator

@ericbrown99 ericbrown99 commented Aug 13, 2025

New Mini App IA
Focused on discoverability, AI optimizations, and progressive disclosure. Mixes:

  • Journey-focused: Quickstart + UX Guidelines + Growth Playbook
  • Feature-focused: Mini App Features + Technical Reference

Key updates

  • Long pages split into short sub-pages → better devX & AI indexing
  • Get Featured (after Quickstart) → carrot for devs aiming for distribution & quality bar
  • Design & UX Standards → best practices for implementing features
  • Growth Playbook → post-launch support + future Base Build MVP analytics content
  • Troubleshooting → common, non-feature-specific issues in one place
  • Technical Reference → detailed specs (minikit + possibly Farcaster SDK)

Next steps

  • Implement with existing content today
  • Add new content
    -UX study

@cb-heimdall
Copy link
Collaborator

cb-heimdall commented Aug 13, 2025

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@ericbrown99 ericbrown99 changed the title overhaul IA and scaffold new docs Overhaul Mini Apps IA and scaffold new docs Aug 13, 2025
@ericbrown99 ericbrown99 changed the title Overhaul Mini Apps IA and scaffold new docs Overhaul Mini Apps IA and scaffold new docs | WIP Aug 13, 2025
@@ -0,0 +1,8 @@
---
title: OnchainKit Usage in Mini Apps
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: I think it's enough to say "OnchainKit" / drop "Mini Apps" from most titles to make everything easier to skim. The pages are under "Mini Apps" tab so it's implied that they're for mini apps.

@@ -0,0 +1,74 @@
---
title: Launch Guide
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: "Launch Checklist"

@@ -0,0 +1,32 @@
---
title: Feature Tour
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: "Features" - I love World's conciseness is page-naming. It makes the docs easy to skim and discover the content.

@@ -0,0 +1,54 @@
---
title: Manifest Creation
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: "Create Manifest" — to keep formatting consistent, we should stick with the same verb + noun pattern used for other action names.

]
},
{
"group": "Growth Playbook",
Copy link
Collaborator

Choose a reason for hiding this comment

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

love this section!

]
},
{
"group": "Troubleshooting",
Copy link
Collaborator

Choose a reason for hiding this comment

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

love!!

"pages": [
"mini-apps/quality-and-publishing/overview",
"mini-apps/quality-and-publishing/quality-bar",
"mini-apps/quality-and-publishing/submission-guidelines"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let’s make sure there’s no duplicate content between "quality-bar" and "submission-guidelines". We can keep things clearer by having one distinct checklist for each purpose e.g. one for Launch, one for Submission—this way, it’s easier for builders to follow and for our team to iterate on together.

"mini-apps/design-ux/design-patterns-for-mini-apps",
"mini-apps/design-ux/onchainkit-usage",
"mini-apps/design-ux/ui-patterns",
"mini-apps/design-ux/language-and-tone"
Copy link
Collaborator

Choose a reason for hiding this comment

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

would remove for now unless DevRel has already made the content for it

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Definitely. This section is just placeholder for the docs you and your team are looking to add

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.

3 participants