site: regenerate

Close #4

Author: yurrriq

docs/index.html

@@ -110,7 +110,38 @@ <h3 id="prerequisites">Prerequisites</h3>
 <h2 id="contributing">Contributing</h2>
 <p><em>TBD</em> (see <a href="https://github.com/idris-hackers/software-foundations/issues/4">issue #4</a> for discussion)</p>
 <h3 id="general-workflow">General Workflow</h3>
-<p><em>TODO: write me</em></p>
+<ol>
+<li><a href="https://github.com/idris-hackers/software-foundations/fork">Fork the repository</a> if you haven't already.</li>
+<li>Check the <a href="https://github.com/idris-hackers/software-foundations/pulls">open pull requests</a> for any related work in progress (WIP).</li>
+<li>Check out a new branch based on <code>develop</code>.</li>
+<li>Push some commits to your fork.</li>
+</ol>
+<ul>
+<li>The general workflow here is as follows:
+<ul>
+<li>Copy/paste the original text, <a href="#formatting">reformatting</a> as<br />
+appropriate.</li>
+<li>Translate Coq code into (idiomatic) Idris.</li>
+<li>Edit, augment and delete text as appropriate.<br />
+<em>N.B. This can be done in subsequent pull requests.</em></li>
+</ul></li>
+</ul>
+<ol>
+<li>Open a pull request (as soon as possible).</li>
+</ol>
+<ul>
+<li>If it's not ready to be merged, but you want to <em>claim</em> a particular task,<br />
+prefix the pull request with <code>WIP:</code>.</li>
+<li>Make a comment and remove the <code>WIP:</code> when it's ready to be reviewed and<br />
+merged. <em>Remember: formatting the text and taking a first pass at<br />
+translating the Coq to Idris is enough for an initial pull request.</em></li>
+</ul>
+<ol>
+<li>Open subsequent pull requests following a similar pattern for and edits or<br />
+other updates</li>
+</ol>
+<p>The <code>develop</code> branch is the <em>working branch</em> and <code>master</code> is for <em>releases</em>,<br />
+i.e. rebuilt <a href="https://idris-hackers.github.io/software-foundations/pdf/sf-idris-2016.pdf">PDF</a>s and <a href="https://idris-hackers.github.io/software-foundations">website</a> updates.</p>
 <h3 id="formatting">Formatting</h3>
 <p>When formatting the <a href="http://docs.idris-lang.org/en/latest/tutorial/miscellany.html#literate-programming">Literate Idris</a> source, we use <a href="https://wiki.haskell.org/Literate_programming#Bird_Style">bird tracks</a> for code meant<br />
 to be compiled and a combination of <a href="https://daringfireball.net/projects/markdown/">Markdown</a> and <a href="http://www.latex-project.org">LaTeX</a> for commentary and<br />
@@ -167,18 +198,19 @@ <h4 id="code-blocks">Code Blocks</h4>
 <h4 id="inline-code">Inline Code</h4>
 <p>For inline Idris code, use the custom <code>\mintinline</code> shortcut <code>\idr</code>, e.g.</p>
 <div class="sourceCode"><pre class="sourceCode tex"><code class="sourceCode latex">To print ``Hello World!&#39;&#39; in Idris, write <span class="fu">\idr</span>{putStrLn &quot;Hello, World!&quot;}.</code></pre></div>
-<p>For convenience, we've also defined the shortcut <code>\el</code> for ineline Emacs Lisp<br />
+<p>For convenience, we've also defined the shortcut <code>\el</code> for inline Emacs Lisp<br />
 code, e.g.</p>
 <div class="sourceCode"><pre class="sourceCode latex"><code class="sourceCode latex">Set the value of <span class="fu">\el</span>{foo} to <span class="fu">\el</span>{42}: <span class="fu">\el</span>{(setq foo 42)}.</code></pre></div>
 <p>Otherwise, use single backticks for inline monospace text, e.g.</p>
 <pre><code>This is some `inline monospaced text`.</code></pre>
 <p>In a certain cases, we might want syntax highlighting for a language other than<br />
-Idris or Emacs Lisp. For such cases, use the standard <code>\mintline</code> command, e.g.</p>
+Idris or Emacs Lisp. For such cases, use the standard <code>\mintinline</code> command,<br />
+e.g.</p>
 <div class="sourceCode"><pre class="sourceCode tex"><code class="sourceCode latex">To declare a theorem in Coq, use <span class="fu">\mintinline</span>[]{coq}{Theorem}.</code></pre></div>
 <h4 id="glossary">Glossary</h4>
 <p>We use the <a href="https://www.ctan.org/pkg/glossaries">glossaries package</a> for defining terms<br />
 (in <a href="https://github.com/idris-hackers/software-foundations/blob/master/src/glossary.tex"><code>src/glossary.tex</code></a>) and including a glossary in<br />
-the [generated PDF][PDF]. See the package documentation for more information,<br />
+the <a href="https://idris-hackers.github.io/software-foundations/pdf/sf-idris-2016.pdf">generated PDF</a>. See the package documentation for more information,<br />
 but here's a quick example:</p>
 <div class="sourceCode"><pre class="sourceCode tex"><code class="sourceCode latex">What is the <span class="fu">\gls</span>{meaning of life}?
 
@@ -187,7 +219,7 @@ <h4 id="glossary">Glossary</h4>
   description={42}
 }</code></pre></div>
 <h3 id="generating-the-pdf">Generating the PDF</h3>
-<p>To generate the [PDF] we use [Pandoc] and [latexmk]. For more details, check out<br />
+<p>To generate the <a href="https://idris-hackers.github.io/software-foundations/pdf/sf-idris-2016.pdf">PDF</a> we use <a href="http://pandoc.org">Pandoc</a> and <a href="https://www.ctan.org/pkg/latexmk/">latexmk</a>. For more details, check out<br />
 the <code>all.pdf</code>, <code>all.tex</code> and <code>%.tex</code> rules in <a href="https://github.com/idris-hackers/software-foundations/blob/master/src/glossary.tex"><code>src/Makefile</code></a>.</p>
 <!-- Named Links -->
 </body>