Skip to content

Commit

Permalink
Merge pull request #10 from mrp089/community_standards_8
Browse files Browse the repository at this point in the history
Contributing section
  • Loading branch information
lucapegolotti authored Oct 9, 2023
2 parents 4157991 + 41bf02a commit 0e1374b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ If markdown does not seem to be rendering properly, check out the <a href="#note

If you still have questions after reading through this documentation, you can contact the developer of this website Carole Darve at [email protected].

## Viewing the documentation locally

When updating the documentation (see below), you can build it locally on your computer. If you're using Visual Studio Code, you can download the [Live Server Plugin](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer). Then, right-click anywhere in `index.html` and select `Open with Live Server`.

## Updating the documentation

Thank you for updating SimVascular's documentation.
Expand Down
23 changes: 16 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,15 @@ <h1 id="support">Getting Support</h1>
</div>

<div class="everyOtherSection">
<div class="newSectionHeader">
<h1 id="support">Contributing</h1>
</div>
<div class="newSectionContent supportContainer" style="text-align: center;">
<p class="supportDescription">SimVascular is an open-source project and we welcome contributions! All development happens in our solvers' <a target="_blank" href="https://github.com/SimVascular">GitHub repositories</a>. Please read our <a href="https://github.com/SimVascular/.github/blob/main/CODE_OF_CONDUCT.md" target="_blank">Code of Conduct</a> and <a href="https://github.com/SimVascular/.github/blob/main/CONTRIBUTING.md" target="_blank">Contributing Guidelines</a>.</p>
</div>
</div>

<div class="section">
<div class="newSectionHeader">
<h1 id="gallery">Gallery</h1>
</div>
Expand Down Expand Up @@ -535,7 +544,7 @@ <h2>
</div>
</div>-->

<div class="section">
<div class="everyOtherSection">
<div class="newSectionHeader">
<h1 id="repository">The Vascular Model Repository</h1>
</div>
Expand All @@ -561,7 +570,7 @@ <h2 style="margin: 15px 0">Its purpose</h2>
</div>
</div>

<div class="everyOtherSection">
<div class="Section">
<div class="newSectionHeader">
<h1 id="gateway">Supercomputing Gateway</h1>
</div>
Expand All @@ -570,7 +579,7 @@ <h1 id="gateway">Supercomputing Gateway</h1>
</div>
</div>

<div class="section">
<div class="everyOtherSection">
<div class="newSectionHeader">
<h1 id="socials">Socials</h1>
</div>
Expand Down Expand Up @@ -617,7 +626,7 @@ <h2>
</div>
</div>

<div class="everyOtherSection">
<div class="Section">
<div class="newSectionHeader">
<h1 id="news">Recent News</h1>
</div>
Expand Down Expand Up @@ -654,7 +663,7 @@ <h1 id="news">Recent News</h1>
</div>
</div>

<div class="section" style="padding-bottom: 30px">
<div class="everyOtherSection" style="padding-bottom: 30px">
<div class="newSectionHeader">
<h1 id="team">Team</h1>
</div>
Expand Down Expand Up @@ -748,7 +757,7 @@ <h1 id="team">Team</h1>
</div>
</div>

<div class="everyOtherSection">
<div class="Section">
<div class="newSectionHeader">
<h1 id="institutions">Institutions</h1>
</div>
Expand All @@ -767,7 +776,7 @@ <h1 id="institutions">Institutions</h1>
</div>
</div>

<div class="section">
<div class="everyOtherSection">
<div class="newSectionHeader">
<h1 id="acknowledgements">Acknowledgements</h1>
</div>
Expand Down

0 comments on commit 0e1374b

Please sign in to comment.