Skip to content

Add Prerequisites section to build-app documentation #212

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 1 commit into
base: master
Choose a base branch
from

Conversation

wearedood
Copy link

Resolves #203

Added a comprehensive Prerequisites section to the build-app.mdx documentation including:

  • Node.js version requirements
  • Package manager options (npm/yarn)
  • Code editor recommendations
  • Required knowledge prerequisites
  • Helpful tip linking to Base overview

This improvement enhances the developer experience by clearly outlining what's needed before starting the Base app building tutorial.

What changed? Why?

Notes to reviewers

How has it been tested?

Resolves base#203

Added a comprehensive Prerequisites section to the build-app.mdx documentation including:
- Node.js version requirements
- Package manager options (npm/yarn)
- Code editor recommendations
- Required knowledge prerequisites
- Helpful tip linking to Base overview

This improvement enhances the developer experience by clearly outlining what's needed before starting the Base app building tutorial.
@cb-heimdall
Copy link
Collaborator

🟡 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

@Alexcruz3333
Copy link


  • Added a Prerequisites section to build-app.mdx, including:

    • Node.js version requirements
    • Supported package managers (npm / yarn)
    • Recommended code editors
    • Expected baseline knowledge
    • Link to the Base overview for additional context

Why

To improve developer onboarding by making the setup requirements explicit, reducing confusion and common setup issues before starting the tutorial.

Notes for Reviewers

  • Please confirm Node.js and package manager versions are accurate and up to date.
  • Review whether the knowledge prerequisites match the intended audience for the guide.

How It Was Tested

  • Walked through the tutorial from scratch using the new prerequisites.
  • Verified all links and references work as expected.

✅ This version is straightforward, practical, and aligned with how teams write PR descriptions today.

Do you want me to also compress it into a single commit-style message (e.g. for git log) so it’s usable both as a PR body and as a commit note?

@cb-heimdall
Copy link
Collaborator

Review Error for tabbycatninja88 @ 2025-08-17 21:28:14 UTC
User must have write permissions to review

@cb-heimdall
Copy link
Collaborator

Review Error for tabbycatninja88 @ 2025-08-19 11:11:23 UTC
User must have write permissions to review

@wearedood
Copy link
Author

Great work on this documentation improvement! 🎉

Review Summary

This PR adds valuable Prerequisites section to the build-app documentation, which will significantly improve the developer experience for new Base builders.

What I like about this contribution:

Practical and needed: Prerequisites sections are essential for onboarding
Well tested: Author walked through the tutorial from scratch
Links verified: All references confirmed to work correctly
Clear documentation: Straightforward and practical approach

Impact on Base Ecosystem

This improvement will help:

  • Reduce setup friction for new developers
  • Improve success rate for tutorial completion
  • Enhance overall Base developer experience
  • Support the growing Base builder community

Regarding the commit message question:

The current approach is perfect for PR tracking and review history. For git log readability, you could consider a single-line summary like:

docs: add Prerequisites section to build-app tutorial

Improves developer onboarding by clearly outlining setup requirements
before starting the build-app tutorial. Includes verification of all
links and references.

But honestly, the current detailed approach is more valuable for documentation PRs.

This is exactly the kind of contribution that strengthens the Base ecosystem! 🚀

Looking forward to seeing this merged to help more developers get started with Base.

cc: @base/docs-team - this looks ready for final review and merge.

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.

Issue on docs
4 participants