Skip to content

docs: clarify create-mn-app project selection flow#707

Open
tusharpamnani wants to merge 9 commits intomidnightntwrk:mainfrom
tusharpamnani:patch-1
Open

docs: clarify create-mn-app project selection flow#707
tusharpamnani wants to merge 9 commits intomidnightntwrk:mainfrom
tusharpamnani:patch-1

Conversation

@tusharpamnani
Copy link
Copy Markdown

Explain that the CLI first prompts users to choose between creating a Contract or a Full DApp. Document the available templates for each:

  • Contract → hello-world
  • Full DApp → counter, bulletin board

Explain that the CLI first prompts users to choose between creating a
Contract or a Full DApp. Document the available templates for each:
- Contract → hello-world
- Full DApp → counter, bulletin board

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
@tusharpamnani tusharpamnani requested review from a team as code owners March 17, 2026 12:58
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 17, 2026

@tusharpamnani is attempting to deploy a commit to the Shielded Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown
Contributor

@DianaHackmamba DianaHackmamba left a comment

Choose a reason for hiding this comment

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

A couple minor edits.

@gyrationtechs, please take a look.

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
@barnazaka
Copy link
Copy Markdown
Contributor

Good improvement overall: the two-step flow (project type first, then template) is much clearer than the original single flat list. A few things worth addressing before this gets merged:

  1. Inconsistent template descriptions
    The Contract section includes a description of the hello-world template: "a basic example that demonstrates how to deploy a Compact contract and interact with it from the CLI." But the Full DApp section lists Counter and Bulletin board with no equivalent descriptions. A developer reading this has no idea what either template does or which one to pick. Both templates should have a one-sentence description the same way hello-world does.

  2. The arrow notation Contract --> Hello world is unexplained
    The closing line uses Contract --> Hello world to reference the selection path, but this arrow syntax was never introduced to the reader. Someone completely new to the CLI may not immediately understand this means two separate prompts in sequence. Consider writing it out explicitly as: "select Contract at the first prompt, then Hello world at the second prompt."

  3. Missing guidance for new developers on which path to choose
    The doc presents Contract vs Full DApp as equal choices with no hint about which is better for a first-time user. Adding a short note like "If you are new to Midnight, start with Contract to get familiar with the basic deployment flow before scaffolding a full application" would significantly improve the onboarding experience.

  4. No forward reference for the Full DApp path
    The rest of the quickstart guide only follows the Contract → Hello world path. After listing Counter and Bulletin board as options, there is no link or note pointing readers to where those templates are covered. A reader who picks Full DApp will be left without guidance. Either add a brief note pointing to the relevant tutorials or make it explicit that this guide only covers the Contract path.

Overall the direction of this PR is right and the tense fix from the previous review was correctly applied. Addressing these points would make it genuinely useful for developers hitting the quickstart for the first time.

gyrationtechs
gyrationtechs previously approved these changes Mar 18, 2026
Copy link
Copy Markdown
Contributor

@gyrationtechs gyrationtechs left a comment

Choose a reason for hiding this comment

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

LGTM

gyrationtechs and others added 2 commits March 18, 2026 16:39
- Add descriptions for Counter and Bulletin board templates
- Replace "Contract → Hello world" arrow notation with explicit prompt flow
- Add guidance recommending the Contract path for new developers
- Add forward references for Full DApp templates

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
@tusharpamnani
Copy link
Copy Markdown
Author

Thanks for the detailed review, these are great suggestions for improving the onboarding flow.

I’ve addressed the feedback as follows:

• Added one-sentence descriptions for the Counter and Bulletin board templates to match the hello-world explanation.
• Replaced the Contract → Hello world arrow notation with explicit wording describing the two prompts.
• Added guidance recommending the Contract path for developers new to Midnight.
• Added forward references to the Counter and Bulletin board tutorials so users who select Full DApp know where to continue.

Let me know if you'd like any additional clarification or changes.

Copy link
Copy Markdown
Contributor

@gyrationtechs gyrationtechs left a comment

Choose a reason for hiding this comment

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

A few minor edits.

- removed the word 'simple' from the description of counter template 
- replaced 'Zero Knowledge' with 'zero-knowledge (zk)' in the description of bulletin board template 

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
@tusharpamnani
Copy link
Copy Markdown
Author

Hey @gyrationtechs, I've updated the PR with requested changes.
Please take a look

Copy link
Copy Markdown
Contributor

@gyrationtechs gyrationtechs left a comment

Choose a reason for hiding this comment

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

One last thing. Then G2G

Updated zk to ZK

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
gyrationtechs
gyrationtechs previously approved these changes Mar 20, 2026
@tusharpamnani
Copy link
Copy Markdown
Author

hey, @DianaHackmamba could you please take a look at teh changes

Signed-off-by: Tushar Pamnani <121151091+tusharpamnani@users.noreply.github.com>
@tusharpamnani
Copy link
Copy Markdown
Author

hey @DianaHackmamba i've made the requested changes

@DianaHackmamba DianaHackmamba self-requested a review April 3, 2026 21:30
@DianaHackmamba
Copy link
Copy Markdown
Contributor

@gyrationtechs will provide final approval.

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.

4 participants