Split things out more nicely for #6

Author: DanielOaks

README.md

@@ -1,17 +1,25 @@
-# Modern IRC
+# Modern IRC Documents
 
-This is an attempt to create an updated document about how the IRC client protocol works these days.
+This site contains documents describing the IRC protocol and related technologies. The documents hosted here are intended to be useful to software developers working with IRC.
 
-This document does not specify brand new stuff -- only existing behaviour and what we consider best-practices for new software. Where external, up-to-date and authoritative specifications exist for commands and messages, we prefer to link to those rather than needlessly rewrite sections (see the [`CAP`](http://modern.ircdocs.horse/#cap-message) message for an example of this).
+* [Modern IRC Client Protocol](http://modern.ircdocs.horse/) document
 
-We specify commands, messages and numerics as SHOULD and MUST based on how much of the IRC software out there today uses them (as well as the guidance of the RFCs and common-sense). Someone writing a client or server based off this document SHOULD end up with an implementation that interacts nicely with most IRC software and networks out there today.
+For suggestions of other documents to create / maintain, please [create an issue](https://github.com/ircdocs/modern-irc/issues) or [send me an email](mailto:[email protected])!
 
-This document is not an RFC. Writing an RFC and putting it through the IETF process is the job of someone else, and whoever does it is free to use anything from this document. Just try to respect the authors section at the top of the page if a decent amount of text is used. Look at [ircv3-harmony](https://github.com/kaniini/ircv3-harmony) for something which aims to be an RFC.
+The behaviour and constants described in these documents SHOULD converge, and/or be interoperable with the majority of IRC software. These documents should allow a client or server author to build software which can communicate with almost any other piece of IRC software it interacts with.
 
-If something written in here isn't correct for or interoperable with an IRC server / network you know of, please open an issue or send me an [email](mailto:[email protected]). Pull requests are appreciated.
+These documents contain existing behaviour and what we consider best-practices for new software. Where external, up-to-date and authoritative specifications exist for commands/messages/behaviours, we prefer to link to those rather than needlessly rewrite them (see the Client Protocol's [`CAP`](http://modern.ircdocs.horse/#cap-message) message for an example of this).
 
-This covers the client-server protocol only, and does not touch the S2S protocol. The reasons for this are discussed in the document. This document includes bits and pieces cherry-picked from the RFCs, [IRCv3](http://ircv3.net/), Internet-Drafts, and commands/replies that have generally been accepted by the IRC community.
+These document are not RFCs. Writing an RFC and putting it through the IETF process is the job of someone else, and whoever does it is free to use anything from these documents. Just respect the authors section at the top of the document if a decent amount of text is used from it. Look at [ircv3-harmony](https://github.com/kaniini/ircv3-harmony) for something which aims to be an RFC.
+
+If something written in these documents isn't correct for or interoperable with an IRC client / server / network you know of, please open an issue or send me an [email](mailto:[email protected]). Pull requests are appreciated.
 
 ---
 
-This document draws from [RFC1459](https://tools.ietf.org/html/rfc1459) and [RFC2812](https://tools.ietf.org/html/rfc2812), as well as other specifications and drafts [listed](http://modern.ircdocs.horse/#acknowledgements).
+## Modern IRC Client Protocol
+
+This is an attempt to create an updated document about how the IRC client protocol works these days.
+
+We specify commands, messages and numerics as SHOULD and MUST based on how much of the IRC software out there today uses them (as well as the guidance of the RFCs and common-sense). Someone writing a client or server based off this document SHOULD end up with an implementation that interacts nicely with most IRC software and networks out there today.
+
+This ignores the S2S protocol. The reasons for this are discussed in the document. This document includes bits and pieces cherry-picked from the RFCs, [IRCv3](http://ircv3.net/), Internet-Drafts, and commands/replies that have generally been accepted by the IRC community.

_includes/copyrights.html

@@ -3,7 +3,11 @@
     <div class="pure-u-1-{{ page.copyrights | size }}">
         <span class="line">{{ copyright.name }}</span>
         {% if copyright contains "org" %}
-        <span class="line">{{ copyright.org }}</span>
+            {% if copyright contains "org_link" %}
+                <a href="{{ copyright.org_link }}" class="line">{{ copyright.org }}</a>
+            {% else %}
+                <span class="line">{{ copyright.org }}</span>
+            {% endif %}
         {% endif %}
         <span class="line"><a href="mailto:{{ copyright.email }}">{{ copyright.email }}</a></span>
     </div>

_includes/appendixes.md renamed to _includes/modern-appendix.md

@@ -21,7 +21,7 @@ <h2>Table of Contents</h2>
 
         <div id="wrapper">
             <div id="content">
-                <h1>Modern IRC</h1>
+                <h1>{{ page.title }}</h1>
 
                 <div id="spec">
                     {{ content }}
@@ -31,7 +31,8 @@ <h1>Modern IRC</h1>
         <div id="footer">
             <hr/>
             <p>The canonical version of this document is hosted at <a href="http://modern.ircdocs.horse/">http://modern.ircdocs.horse</a></p>
-            <p>Pull requests may be submitted and the source code for it can be found at <a href="https://github.com/ircdocs/modern-irc">http://github.com/ircdocs/modern-irc</a></p>
+            <p>This site hosts the <a href="./index.html">Modern IRC Client Protocol</a> document.<br>Further information can be found on the <a href="./about.html">About</a> page.</p>
+            <p>Pull requests may be submitted to and the source code for these documents can be found at <a href="https://github.com/ircdocs/modern-irc">http://github.com/ircdocs/modern-irc</a></p>
         </div>
     </body>
     <script>

_layouts/default.html

@@ -0,0 +1,26 @@
+---
+title: About
+layout: default
+---
+
+This site contains documents describing the IRC protocol and related technologies. The documents hosted here are intended to be useful to software developers working with IRC.
+
+* [Modern IRC Client Protocol](./index.html) document.
+
+For suggestions of other documents to create / maintain, please [create an issue](https://github.com/ircdocs/modern-irc/issues) or [send me an email](mailto:[email protected])!
+
+The behaviour and constants described in these documents SHOULD converge, and/or be interoperable with the majority of IRC software. These documents should allow a client or server author to build software which can communicate with almost any other piece of IRC software it interacts with.
+
+These documents contain existing behaviour and what we consider best-practices for new software. Where external, up-to-date and authoritative specifications exist for commands/messages/behaviours, we prefer to link to those rather than needlessly rewrite them (see the Client Protocol's [`CAP`](http://modern.ircdocs.horse/#cap-message) message for an example of this).
+
+These document are not RFCs. Writing an RFC and putting it through the IETF process is the job of someone else, and whoever does it is free to use anything from these documents. Just respect the authors section at the top of the document if a decent amount of text is used from it. Look at [ircv3-harmony](https://github.com/kaniini/ircv3-harmony) for something which aims to be an RFC.
+
+If something written in these documents isn't correct for or interoperable with an IRC client / server / network you know of, please open an issue or send me an [email](mailto:[email protected]). Pull requests are appreciated.
+
+---
+
+## Living Specification
+
+We consider the documents on this site to be 'living specifications'. This means they are updated as feedback is received for them and as the protocol is extended and grows. Bugs can be fixed, incorrect behaviours in the specifications can be corrected, and they can be extended as new behaviour becomes widespread.
+
+This term and our use of it is based on the WHATWG definition of a ['living standard'](https://wiki.whatwg.org/wiki/FAQ#What_does_.22Living_Standard.22_mean.3F).

about.md

@@ -1,20 +1,23 @@
 ---
-title: Modern IRC
+title: Modern IRC Client Protocol
 layout: default
 copyrights:
   -
     name: "Jack Allnutt"
     org: "Kiwi IRC"
+    org_link: "https://kiwiirc.com/"
     email: "[email protected]"
   -
     name: "Daniel Oaks"
+    org: "ircdocs"
+    org_link: "http://ircdocs.horse/"
     email: "[email protected]"
 ---
 
 {% include copyrights.html %}
 
 <div class="warning">
-    <p>This document intends to be a useful overview and reference of the IRC client protocol as it is implemented today. It is NOT a concrete specification and does not specify brand new stuff &ndash; only existing behaviour and what we consider best-practices for new software.</p>
+    <p>This document intends to be a useful overview and reference of the IRC client protocol as it is implemented today. It is a <a href="./about.html#living-specification">living specification</a> which is updated in response to feedback and implementations. This document describes existing behaviour and what we consider best practices for new software.</p>
     <p>If something written in here isn't correct for or interoperable with an IRC server / network you know of, please <a href="https://github.com/ircdocs/modern-irc/issues">open an issue</a> or <a href="mailto:[email protected]">contact me</a>.</p>
     <p>For something which aims to be an RFC, please see the <a href="https://github.com/kaniini/ircv3-harmony">ircv3-harmony</a> project.</p>
 </div>
@@ -1262,7 +1265,7 @@ Users with this mode may send messages to a channel that is [moderated](#moderat
 
 <div id="appendixes">
 
-{% capture appendixes %}{% include appendixes.md %}{% endcapture %}
+{% capture appendixes %}{% include modern-appendix.md %}{% endcapture %}
 {{ appendixes | markdownify }}
 
 </div>