docs: Fix missing directory context in Hello World Frontend guide#2268
docs: Fix missing directory context in Hello World Frontend guide#2268
Conversation
Co-authored-by: oceans404 <91382964+oceans404@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR fixes critical directory navigation issues in the Hello World Frontend tutorial that were causing user confusion. The guide previously lacked context about where to run commands relative to the contract project directory.
Changes:
- Added explicit directory navigation instructions with inline comments explaining the working directory context
- Changed placeholder project name from
extra-escapetohello-world-frontendfor consistency - Fixed grammar error: "created in as a NPM package" → "created as a NPM package"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ElliotFriend
left a comment
There was a problem hiding this comment.
i think this actually misunderstands the typical conventions used in projects like this. often, you'll have a soroban-hello-world project directory that contains both the contracts and frontend files side-by-side. that's also the way scaffold does it in their default setup: with a /soroban-hello-world/contracts directory for the smart contracts, and a /soroban-hello-world/src directory where all the React stuff lives.
Given the broader context of "continuing on" in the getting started guide, it feels more appropriate to keep the frontend files within the soroban-hello-world directory. we could probably make it more overt that this convention is being followed, and add some hints like cd path/to/soroban-hello-world here and there, though. perhaps that would be helpful to mitigate confusion for readers?
The Hello World Frontend guide omitted critical working directory context, leaving users confused about where to run
npm create astro@latestandstellar contract bindings typescriptrelative to their contract project.Changes
cd ..beforenpm create astro@latest, explicit project namehello-world-frontend, and explanation that the frontend is a sibling to the contract directoryextra-escapewithhello-world-frontendcd soroban-hello-worldbefore the bindings command with explanation that it must run from the contract directory (to resolve the alias); update--output-dirto use the correct relative path:cd packages/hello_world→cd ../hello-world-frontend/packages/hello_worldcd ../..lands the user inhello-world-frontend, sonpm run devcan be run immediatelyOriginal prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.