From fa9072aadc27a8c7d8a509c67ad2681f25acb8f2 Mon Sep 17 00:00:00 2001 From: tlylt Date: Mon, 26 Jul 2021 19:59:03 +0800 Subject: [PATCH] Update devGuide setting up section I have personally encountered an setup issue thus I think it might help others if we include more details in setting up guide. The current setup guide is rather terse. Let's add a 'common setup issues' section to provide helpful tips and more FAQ in the future to help with first timers when they get the project ready for development. This will allow for easier onboarding process for new developers. I have also fixed a minor typo. --- docs/devGuide/settingUp.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/devGuide/settingUp.md b/docs/devGuide/settingUp.md index 5910401240..d716cb0c13 100644 --- a/docs/devGuide/settingUp.md +++ b/docs/devGuide/settingUp.md @@ -44,5 +44,12 @@ We recommend the **WebStorm IDE** for working with MarkBind code. MarkBind uses [lerna](https://github.com/lerna/lerna), a popular multi-package development tool, to manage it's dependencies. It is essentially a high level wrapper over node and npm's functionalities +1. **Congratulations!** Now you are ready to start modifying MarkBind code. -1. **Congratulations!** Now you ready to start modifying MarkBind code. +## Common setup issues + +Having issues with setting up the project properly? Check if you have: +- Installed all required dependencies listed in the above [Prerequsisites section](#prerequisites). Notably, check that the versions of the required dependencies are at least or greater than the required versions. +- Followed the steps in the above[Setting up section](#setting-up-the-dev-environment) in the same order. + +Lastly, check if there are any errors logged out in the console and search online for common fixes. If the issues persist, please reach out to us by posting in [our issue tracker](https://github.com/markbind/markbind/issues). \ No newline at end of file