docs: Refine Framework Quickstart guide with streamlined steps, clearer instructions, and screenshots#596
Conversation
ajot
commented
Oct 14, 2024
- Added overview and conclusion to provide context and next steps
- Expanded editor instructions with hands-on steps for adding components, adjusting settings, and updating the app name
- Updated app creation command for clarity, with a breakdown of key project files
- Simplified port info and security tips for running the editor and app
- Added screenshots for visual guidance through the editor and app preview
- Removed module-based app running to keep the guide beginner-friendly
… and screenshots - Added overview and conclusion to provide context and next steps - Expanded editor instructions with hands-on steps for adding components, adjusting settings, and updating the app name - Updated app creation command for clarity, with a breakdown of key project files - Simplified port info and security tips for running the editor and app - Added screenshots for visual guidance through the editor and app preview - Removed module-based app running to keep the guide beginner-friendly
docs/framework/quickstart.mdx
Outdated
| This command opens the Writer Framework editor in your browser, where you’ll see a live preview of your app. The editor interface includes a **component library** on the left, a **canvas** in the center for building layouts, and a **settings panel** on the right for customizing selected components. | ||
|
|
||
| <Info> | ||
| The editor starts by default on port 3006. If you launch multiple editors in parallel and do not specify a port, Writer Framework will automatically assign the next port until reaching the limit of 4099. |
There was a problem hiding this comment.
This port range isn't correct, the original statement is
The editor starts by default on port 4005.
There was a problem hiding this comment.
@ajot can we fix this? Happy to merge afterwards
There was a problem hiding this comment.
@ramedina86 Maybe I am missing something, but for me, the editor starts at port 3006 by default, and the app runs at port 3005. Is that incorrect?
cc/ @samjulien
There was a problem hiding this comment.
@ajot I believe this changed in the latest RC, you should see it when you test Workflows (right @ramedina86?)
I think this is one example of why we switched the docs to go from main instead of dev.
There was a problem hiding this comment.
The port policy has changed to allow the writer cli to find available port by itself : #567.
On release candidate for 0.8, the port for the run start at 3005, the port for editor start at 4005
Updating the port information for editor.