Skip to content
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

Prepare documentation for development environment setup #20

Closed
kutluhanmetin opened this issue May 23, 2019 · 6 comments
Closed

Prepare documentation for development environment setup #20

kutluhanmetin opened this issue May 23, 2019 · 6 comments
Assignees

Comments

@kutluhanmetin
Copy link

It would be great to have a documentation for setting up development environment.
I had issues with following and had to figure out myself:

So I think adding a documentation called "Setting Up Development Environment" should be considered.

@mittalyashu mittalyashu transferred this issue from gitthermal/thermal May 23, 2019
@mittalyashu
Copy link
Member

mittalyashu commented May 23, 2019

So I think adding documentation called "Setting Up Development Environment" should be considered.

That's really a great idea @kutluhanmetin.

I had issues with the following and had to figure out myself:
I have no experience with yarn before. I had several errors after applying this
guide: https://thermal.codecarrot.net/docs/contribution-guide/ under 'Getting the sources
'. Because I'm using the wrong yarn. I think we should add a few lines to fix it, as this link mentions: yarnpkg/yarn#5448

Did you make sure you have installed the correct and up to date version of yarn?

Is there any specific part which you found while setting up the development environment, except the yarn problem.

I also have no experience about developing electron apps

Believe me, this Thermal app is my first electron project 😅

had difficulties about debugging the app, we can add such documentation about this: http://blog.matsu.io/debug-electron-vscode

Are you referring about debugging the electron application using VS Code Debug feature? If that's the case you can subscribe to this PR gitthermal/thermal#52

@mittalyashu mittalyashu changed the title Preparing a Documentation for Development Environment Setup Prepare documentation for development environment setup May 23, 2019
@mittalyashu
Copy link
Member

@kutluhanmetin
Copy link
Author

Well, it looks good I think.

Did you make sure you have installed the correct and up to date version of yarn?

No, I didn't. There is another yarn which is irrelevant.

@mittalyashu
Copy link
Member

Great.

Please follow the same steps as mentioned in the docs regarding setting up the development environment.

No, I didn't. There is another yarn which is irrelevant.

Just a side note, we are using this Yarn.

@mittalyashu mittalyashu self-assigned this May 24, 2019
@LautaroLobo12
Copy link

Setup development environment leads to a 404 page, do you need help on this? It would be great if that page exists, helps newcomers.

@mittalyashu
Copy link
Member

mittalyashu commented Jul 27, 2019

Hello @LautaroLobo12,

I guess you referring to this page.

Appreciate 👏🏻 your initiative for contributing to docs.

Currently, this page looks very empty, this is the homepage for the docs and if you can create a PR to improve this page, that would be helpful.

Or if you find any page missing, please don't hesitate to create a PR for that as well.

Thanks
Yashu Mittal

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

No branches or pull requests

3 participants