Skip to content

Commit 0e1374b

Browse files
Merge pull request #10 from mrp089/community_standards_8
Contributing section
2 parents 4157991 + 41bf02a commit 0e1374b

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ If markdown does not seem to be rendering properly, check out the <a href="#note
4343

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

46+
## Viewing the documentation locally
47+
48+
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`.
49+
4650
## Updating the documentation
4751

4852
Thank you for updating SimVascular's documentation.

index.html

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,15 @@ <h1 id="support">Getting Support</h1>
429429
</div>
430430

431431
<div class="everyOtherSection">
432+
<div class="newSectionHeader">
433+
<h1 id="support">Contributing</h1>
434+
</div>
435+
<div class="newSectionContent supportContainer" style="text-align: center;">
436+
<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>
437+
</div>
438+
</div>
439+
440+
<div class="section">
432441
<div class="newSectionHeader">
433442
<h1 id="gallery">Gallery</h1>
434443
</div>
@@ -535,7 +544,7 @@ <h2>
535544
</div>
536545
</div>-->
537546

538-
<div class="section">
547+
<div class="everyOtherSection">
539548
<div class="newSectionHeader">
540549
<h1 id="repository">The Vascular Model Repository</h1>
541550
</div>
@@ -561,7 +570,7 @@ <h2 style="margin: 15px 0">Its purpose</h2>
561570
</div>
562571
</div>
563572

564-
<div class="everyOtherSection">
573+
<div class="Section">
565574
<div class="newSectionHeader">
566575
<h1 id="gateway">Supercomputing Gateway</h1>
567576
</div>
@@ -570,7 +579,7 @@ <h1 id="gateway">Supercomputing Gateway</h1>
570579
</div>
571580
</div>
572581

573-
<div class="section">
582+
<div class="everyOtherSection">
574583
<div class="newSectionHeader">
575584
<h1 id="socials">Socials</h1>
576585
</div>
@@ -617,7 +626,7 @@ <h2>
617626
</div>
618627
</div>
619628

620-
<div class="everyOtherSection">
629+
<div class="Section">
621630
<div class="newSectionHeader">
622631
<h1 id="news">Recent News</h1>
623632
</div>
@@ -654,7 +663,7 @@ <h1 id="news">Recent News</h1>
654663
</div>
655664
</div>
656665

657-
<div class="section" style="padding-bottom: 30px">
666+
<div class="everyOtherSection" style="padding-bottom: 30px">
658667
<div class="newSectionHeader">
659668
<h1 id="team">Team</h1>
660669
</div>
@@ -748,7 +757,7 @@ <h1 id="team">Team</h1>
748757
</div>
749758
</div>
750759

751-
<div class="everyOtherSection">
760+
<div class="Section">
752761
<div class="newSectionHeader">
753762
<h1 id="institutions">Institutions</h1>
754763
</div>
@@ -767,7 +776,7 @@ <h1 id="institutions">Institutions</h1>
767776
</div>
768777
</div>
769778

770-
<div class="section">
779+
<div class="everyOtherSection">
771780
<div class="newSectionHeader">
772781
<h1 id="acknowledgements">Acknowledgements</h1>
773782
</div>

0 commit comments

Comments
 (0)