Skip to content

Commit

Permalink
Add Writerside rendered documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@Eve-ning
Eve-ning committed Oct 23, 2023
1 parent 579c01e commit 22f4b76
Show file tree
Hide file tree
Showing 8 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/HelpTOC.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"entities":{"pages":{"Overview":{"id":"Overview","title":"Overview","url":"overview.html","level":0,"tabIndex":0},"Getting-Started":{"id":"Getting-Started","title":"Getting Started","url":"getting-started.html","level":0,"tabIndex":1}}},"topLevelIds":["Overview","Getting-Started"]}
1 change: 1 addition & 0 deletions docs/Map.jhm
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<?xml version='1.0' encoding='UTF-8'?><map version="2.0"><mapID target="Overview.md" url="overview.html" default="yes"/><mapID target="Overview" url="overview.html" default="yes"/><mapID target="Getting-Started.md" url="getting-started.html" default="no"/><mapID target="Getting-Started" url="getting-started.html" default="no"/></map>
1 change: 1 addition & 0 deletions docs/config.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"productVersion":"0.0.4","productId":"d","stage":"release","downloadTitle":"Get Documentation","keymaps":{},"searchMaxHits":75,"productName":"Documentation"}
1 change: 1 addition & 0 deletions docs/current.help.version
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.0.4
22 changes: 22 additions & 0 deletions docs/getting-started.html
View file

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!DOCTYPE html>
<html lang="en-US">
<meta charset="utf-8">
<title>You will be redirected shortly</title>
<meta http-equiv="refresh" content="0; url=overview.html">
<h1>Redirecting&hellip;</h1>
<a href="overview.html">Click here if you are not redirected.</a>
<script>location = "overview.html"</script>
</html>
81 changes: 81 additions & 0 deletions docs/mermaid.css
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/overview.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!DOCTYPE html SYSTEM "about:legacy-compat"><html lang="en-US" data-colors-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"> <meta name="built-on" content="2023-10-23T13:26:37.957627"><meta name="build-number" content="${buildNumber}"> <title>Overview | Documentation</title><script id="virtual-toc-data" type="application/json">[{"id":"other-projects","level":0,"title":"Other Projects","anchor":"#other-projects"}]</script><script id="topic-shortcuts" type="application/json"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.css" rel="stylesheet"> <link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><link rel="manifest" href="https://jetbrains.com/site.webmanifest"><link rel="mask-icon" href="https://jetbrains.com/safari-pinned-tab.svg" color="#000000"><meta name="msapplication-TileColor" content="#000000"/><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"/><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"/><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"/><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"/><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"/> <meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Overview | Documentation"/><meta property="og:description" content=""/><meta property="og:image" content=""/><meta property="og:site_name" content="Documentation Help"/><meta property="og:type" content="website"/><meta property="og:locale" content="en_US"/><meta property="og:url" content="/d/0.0.4/overview.html"/><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Overview | Documentation"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json"> { "@context": "http://schema.org", "@type": "WebPage", "@id": "/d/0.0.4/overview.html#webpage", "url": "/d/0.0.4/overview.html", "name": "Overview | Documentation", "description": "", "image": "", "inLanguage":"en-US" }</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json"> { "@type": "WebSite", "@id": "/d/#website", "url": "/d/", "name": "Documentation Help" }</script><!-- End Schema.org --> <!-- Mermaid light/dark themes --> <link rel="stylesheet" type="text/css" href="mermaid.css"> </head> <body data-id="Overview" data-main-title="Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs="" > <div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Documentation 0.0.4 Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Overview" id="Overview.md" >Overview</h1> <p id="e86100a7_1184">Forest Recovery Digital Companion (FRDC) is a ML-assisted companion for ecologists to automatically classify surveyed trees via an Unmanned Aerial Vehicle (UAV).</p><p id="e86100a7_1185">This package, FRDC-ML is the Machine Learning backbone of this project, a centralized repository of tools and model architectures to be used in the FRDC pipeline.</p><p id="e86100a7_1186"><a href="getting-started.html" id="e86100a7_1187" data-tooltip="Before starting development, take a look at our repository structure. This will help you understand where to put your code." ><span class="control" id="e86100a7_1188">Get started here</span></a></p><section class="chapter"><h2 id="other-projects" data-toc="other-projects">Other Projects</h2><dl id="e86100a7_1189" data-style="title-top"><dt id="e86100a7_1190" data-expandable="false">FRDC-UI</dt><dd><p id="e86100a7_1192"><a href="https://github.com/Forest-Recovery-Digital-Companion/FRDC-UI/" id="e86100a7_1193" data-external="true" rel="noopener noreferrer" >The User Interface Repository</a> for FRDC, a WebApp GUI for ecologists to adjust annotations.</p></dd></dl></section><div class="last-modified"> Last modified: 23 October 2023</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"> <a class="navigation-links__next" href="getting-started.html">Getting Started</a> </div></article><div id="disqus_thread"></div></div></section></main></div> <script src="https://resources.jetbrains.com/writerside/apidoc/6.1.5-b176/app.js"></script></body></html>

0 comments on commit 22f4b76

Please sign in to comment.