Skip to content

Commit

Permalink
doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
@erp12
erp12 committed Sep 10, 2021
1 parent 7657cf2 commit c92ad02
Show file tree
Hide file tree
Showing 17 changed files with 50 additions and 18 deletions.
2 changes: 1 addition & 1 deletion doc_src/code_of_conduct.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Fijit Code of Conduct
# Code of Conduct

These community rules are put in place in order to ensure that development of Fijit stays
focused and productive.
Expand Down
1 change: 1 addition & 0 deletions doc_src/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ If you are inclinded to help with this effort, please see the [contributing guid
## Why the name "Fijit"?

Clojure and Scala are both:

- **F**unctional.
- **I**mmutable-first.
- **J**vm hosted (primarily).
2 changes: 1 addition & 1 deletion doc_src/guide.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fijit Guide
# Guide to Fijit

Clojure is a great language, but some people use Scala... and that's okay!

Expand Down
13 changes: 13 additions & 0 deletions docs/changelog.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Changelog</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 current"><a href="changelog.html"><div class="inner"><span>Changelog</span></div></a></li><li class="depth-1 "><a href="code_of_conduct.html"><div class="inner"><span>Code of Conduct</span></div></a></li><li class="depth-1 "><a href="contributing.html"><div class="inner"><span>Contributing to Fijit</span></div></a></li><li class="depth-1 "><a href="faq.html"><div class="inner"><span>Frequently Asked Questions</span></div></a></li><li class="depth-1 "><a href="guide.html"><div class="inner"><span>Guide to Fijit</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>erp12</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>fijit</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>alpha</span></div></div></li><li class="depth-4"><a href="erp12.fijit.alpha.reflect.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reflect</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.collection.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>collection</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.function.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>function</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.option.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>option</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.try.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>try</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.tuple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tuple</span></div></a></li><li class="depth-3"><a href="erp12.fijit.version.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>version</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#changelog" name="changelog"></a>Changelog</h1>
<h2><a href="#v1-0-initial-release" name="v1-0-initial-release"></a>v1.0 - Initial Release</h2>
<ul>
<li>Support of delegating to correct/compilable implementation based on Scala version.</li>
<li>Scala &lt;=&gt; CLojure collections</li>
<li>Scala functions</li>
<li>Scala <code>Option</code></li>
<li>Scala <code>Try</code></li>
<li>Scala tuples</li>
<li>Alpha version of <code>scala.reflect</code> and <code>scala.compile</code> APIs</li>
</ul></div></div></div></body></html>
2 changes: 1 addition & 1 deletion docs/code_of_conduct.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Fijit Code of Conduct</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 current"><a href="code_of_conduct.html"><div class="inner"><span>Fijit Code of Conduct</span></div></a></li><li class="depth-1 "><a href="contributing.html"><div class="inner"><span>Contributing to Fijit</span></div></a></li><li class="depth-1 "><a href="faq.html"><div class="inner"><span>Frequently Asked Questions</span></div></a></li><li class="depth-1 "><a href="guide.html"><div class="inner"><span>Fijit Guide</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>erp12</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>fijit</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>alpha</span></div></div></li><li class="depth-4"><a href="erp12.fijit.alpha.reflect.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reflect</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.collection.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>collection</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.function.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>function</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.option.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>option</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.try.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>try</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.tuple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tuple</span></div></a></li><li class="depth-3"><a href="erp12.fijit.version.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>version</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#fijit-code-of-conduct" name="fijit-code-of-conduct"></a>Fijit Code of Conduct</h1>
<html><head><meta charset="UTF-8" /><title>Code of Conduct</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name"></span> <span class="project-version"></span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="changelog.html"><div class="inner"><span>Changelog</span></div></a></li><li class="depth-1 current"><a href="code_of_conduct.html"><div class="inner"><span>Code of Conduct</span></div></a></li><li class="depth-1 "><a href="contributing.html"><div class="inner"><span>Contributing to Fijit</span></div></a></li><li class="depth-1 "><a href="faq.html"><div class="inner"><span>Frequently Asked Questions</span></div></a></li><li class="depth-1 "><a href="guide.html"><div class="inner"><span>Guide to Fijit</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>erp12</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>fijit</span></div></div></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>alpha</span></div></div></li><li class="depth-4"><a href="erp12.fijit.alpha.reflect.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reflect</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.collection.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>collection</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.function.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>function</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.option.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>option</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.try.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>try</span></div></a></li><li class="depth-3 branch"><a href="erp12.fijit.tuple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>tuple</span></div></a></li><li class="depth-3"><a href="erp12.fijit.version.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>version</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#code-of-conduct" name="code-of-conduct"></a>Code of Conduct</h1>
<p>These community rules are put in place in order to ensure that development of Fijit stays focused and productive. </p>
<h2><a href="#our-pledge" name="our-pledge"></a>Our Pledge</h2>
<p>In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
Expand Down
Loading

0 comments on commit c92ad02

Please sign in to comment.