documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Create a Guide for Using an Integrated Development Environment (IDE)

Open Grammaresque opened this issue 1 year ago • 5 comments

What about Integrated Development Environments (IDE)? What are you using? Can you document it for others? Someone in the project is working to present documentation for Markchad at some point (an IDE for markdown). But there are more.

To resolve this issue, create a guide showing how you install and run a particular IDE. Add as a new file, to your fork of the the following directory: docs/desktop/tools. When complete, submit a PR to merge to the main branch of the documentation repository. Once it exists, please add that PR# to this issue to make sure they are connected.

For contribution guide visit README.md for this repository.

Note: Docs are generally created in markdown format and include the following meta information at the top:


title: Document title author: the author of the source (English) version of the document. contributors: a comma separated list of contributors to the source document. tested with: a comma separated list of versions, for example 8.6, 9.0 tags:

  • desktop
  • IDE
  • development tool
  • whatever 1-word tags are appropriate

We believe in you. Progress is better than perfection. This is a team effort and your PR reviewer will assist with details.

Grammaresque avatar Oct 05 '24 21:10 Grammaresque

Hello, I'll like to work on this issue. can you assign it to me.

Nabhel avatar Oct 10 '24 00:10 Nabhel

Sounds great! Let me or @sspencerwire know if you have any questions.

Grammaresque avatar Oct 10 '24 01:10 Grammaresque

@Grammaresque Sure I will, thank you so much.

Nabhel avatar Oct 10 '24 15:10 Nabhel

Which IDE were you planning to add, @Nabhel? I’d like to help with this issue, but I want to ensure that I don’t duplicate your efforts.

j0eybrinkman avatar Oct 20 '24 18:10 j0eybrinkman

Great @j0eybrinkman I was planning on adding VS Code as it's the one I am familiar with and use.

Nabhel avatar Oct 21 '24 03:10 Nabhel

Hello, @Nabhel and @j0eybrinkman now that it is November I wanted to check in to see if you still plan to submit these guides. No worries if not, I am just trying to close loose ends after Hacktoberfest. Thank you!

Grammaresque avatar Nov 01 '24 17:11 Grammaresque

I still have some work to do in my neovim doc and may be awhile until I submit it so no need to keep the issue open on my end. Thank you!

j0eybrinkman avatar Nov 02 '24 13:11 j0eybrinkman