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

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

Open
Grammaresque opened this issue Oct 5, 2024 · 7 comments
Open
Assignees
Labels
tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation

Comments

@Grammaresque
Copy link
Collaborator

Grammaresque commented Oct 5, 2024

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 Rocksmarker 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 Grammaresque added tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event labels Oct 5, 2024
@Nabhel
Copy link

Nabhel commented Oct 10, 2024

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

@Grammaresque
Copy link
Collaborator Author

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

@Nabhel
Copy link

Nabhel commented Oct 10, 2024

@Grammaresque Sure I will, thank you so much.

@j0eybrinkman
Copy link
Contributor

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.

@Nabhel
Copy link

Nabhel commented Oct 21, 2024

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

@Grammaresque
Copy link
Collaborator Author

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 Grammaresque removed the hacktoberfest This issue or pull request is ideal for GitHub's Hacktoberfest event label Nov 1, 2024
@j0eybrinkman
Copy link
Contributor

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tag: good first issue Good for newcomers type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants