TIE-77: Project Documentation

[mikecarenzo]

What Changed

• Adds Project Documentation to the Website

How to Contribute

If you haven't already, be sure to install NodeJS on your system.

Setup Preview

1. Switch to the TIE-77_project_documentation branch.
2. cd into ./src/tie-web-interface
3. Run npm install
4. Run npm run dev to launch the development server.

5. Navigate (in your browser of choice) to Local (in this case http://localhost:5173/).

This site will allow you to preview your changes as you make them.

Modifying the Home's Banner Text

To alter the site banner text:

Navigate to ./src/tie-web-interface/src/views/HomeView.vue and alter the file's HTML:

Modifying the About Page

To alter the /about page, navigate to ./src/tie-web-interface/src/views/AboutView.vue and alter the file's HTML.

Here are some formatting tips:

• To establish headers use an <H#> block.

<h1>Heading</h1>
...
<h2>Subheading</h2>
...
<h3>Sub-subheading</h3>
...
<h4>Sub-sub-subheading</h4>
...

• To break up text into paragraphs, place each paragraph in its own <p> block.

<p>Paragraph #1</p>
<p>Paragraph #2</p>
<p>Paragraph #3</p>

• To italicize text, wrap the text in <i></i>.

<i>this text will be in italics</i>

• To bold text, wrap the text in <b></b>.

<b>this text will be bold</b>

• To bold and italicize text, wrap the text in <b><i></i></b>.

<b><i>this text will be bold and in italics</i></b>

• To specify a link use <a href="[URL]">[LINK TEXT]</a>.

<a href="www.google.com">Here's a link to Google.</a>

• To embed an image, place the image in ./src/tie-web-interface/public/images and embed it using <img>.

<img src="/images/example_image.png" style="max-width:600px;">

• To include an inline equation, wrap the equation in $.

$f(x)=x^2 + x + 1$

• To include a block equation (one that is NOT inline with the text), wrap the equation in $$.

$$\mathrm{P = \sum\limits _{i=1}^{n} w( t_{now} -t_{i})}$$

Previewing Your Work

Once you have made AND SAVED your changes to either of the files listed above, those changes will appear instantly in your browser.

Submitting Your Work

Once you're happy with the changes, commit them to this branch like you would any other change.

Keep in Mind

If the about page grows too large, we can break it up into separate pages.

[github-actions]

This PR has been published to https://techniqueinferenceengine.z13.web.core.windows.net/TIE-77_project_documentation/

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 6.73%. Comparing base (c93053d) to head (383f77c).
Report is 9 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main     #35   +/-   ##
=====================================
  Coverage   6.73%   6.73%           
=====================================
  Files         15      15           
  Lines        861     861           
=====================================
  Hits          58      58           
  Misses       803     803           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

This PR has been published to https://techniqueinferenceengine.z13.web.core.windows.net/TIE-77_project_documentation/