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

Fix Drasil Contributor's Guide links #3819

Merged
merged 2 commits into from
Jun 29, 2024
Merged

Fix Drasil Contributor's Guide links #3819

merged 2 commits into from
Jun 29, 2024

Conversation

NoahCardoso
Copy link
Collaborator

I found all the bad links in the contributor's guide. There were only the two bad links that Mr. Smith mentioned in #3816. Closes #3816

@@ -96,7 +96,7 @@ Make sure you fully read through the above [Contributor's Guide](#contributors-g

To get an idea of what Drasil can do, have a look through the [Drasil website](https://jacquescarette.github.io/Drasil/). The website contains links to Software Requirement Specification (SRS) documents, both in an HTML and PDF format. There are also some links to generated code along with a case studies table to demonstrate the variety of choices that can be made by the user at the time of code generation. There are links to documentation within Drasil, as well as a section analyzing Drasil (we'll get to these last two sections later). All of the examples, example code, and the website itself are artifacts generated by Drasil. You can see their source code in the `drasil-example` and `drasil-website` folders respectively.

One of the most important things in working with Drasil is having a solid foundation for using GitHub. Read through [Git2Know](Git2Know) to learn more about branching, pull requests, merging, and anything else git or Github related. Also take a look at the [Makefile documentation](Makefile), since that will be the primary way you compile and use Drasil. More optionally, you may want to take a brief look through [Creating Your Project in Drasil](Creating-Your-Project-in-Drasil), and some [tips for debugging](Debugging-in-Drasil).
One of the most important things in working with Drasil is having a solid foundation for using GitHub. Read through [Git2Know](https://github.com/JacquesCarette/Drasil/wiki/Git2Know-for-Drasil) to learn more about branching, pull requests, merging, and anything else git or Github related. Also take a look at the [Makefile documentation](Makefile), since that will be the primary way you compile and use Drasil. More optionally, you may want to take a brief look through [Creating Your Project in Drasil](Creating-Your-Project-in-Drasil), and some [tips for debugging](Debugging-in-Drasil).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can omit the https://..../ part -- we should only need Git2Know-for-Drasil, no?

Copy link
Collaborator

@balacij balacij left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you!

@JacquesCarette JacquesCarette merged commit ea4cef9 into main Jun 29, 2024
2 checks passed
@JacquesCarette JacquesCarette deleted the linkFix branch June 29, 2024 06:11
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

Successfully merging this pull request may close these issues.

Broken links in Contributor's Guide
3 participants