<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="/default.xsl"?>
<fr:tree xmlns:fr="http://www.forester-notes.org" xmlns:html="http://www.w3.org/1999/xhtml" xmlns:xml="http://www.w3.org/XML/1998/namespace" root="false" base-url="/">
  <fr:frontmatter>
    <fr:authors />
    <fr:date>
      <fr:year>2025</fr:year>
      <fr:month>7</fr:month>
      <fr:day>21</fr:day>
    </fr:date>
    <fr:uri>https://shelter.sirref.org/shelter-0004/</fr:uri>
    <fr:display-uri>shelter-0004</fr:display-uri>
    <fr:route>/shelter-0004/</fr:route>
    <fr:title text="Documentation">Documentation</fr:title>
  </fr:frontmatter>
  <fr:mainmatter />
  <fr:backmatter>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="References">References</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Context">Context</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Backlinks">Backlinks</fr:title>
      </fr:frontmatter>
      <fr:mainmatter>
        <fr:tree show-metadata="true" expanded="false" toc="false" numbered="false">
          <fr:frontmatter>
            <fr:authors>
              <fr:author>
                <fr:link href="https://shelter.sirref.org/The Shelter Developers/" type="external">The Shelter Developers</fr:link>
              </fr:author>
            </fr:authors>
            <fr:date>
              <fr:year>2025</fr:year>
              <fr:month>7</fr:month>
              <fr:day>21</fr:day>
            </fr:date>
            <fr:uri>https://shelter.sirref.org/index/</fr:uri>
            <fr:display-uri>index</fr:display-uri>
            <fr:route>/index/</fr:route>
            <fr:title text="Shelter">Shelter</fr:title>
          </fr:frontmatter>
          <fr:mainmatter>
            <html:p>Welcome to Shelter's documentation.</html:p>
            <html:p>Shelter is a <html:em>metashell</html:em>. A tool for managing shell sessions in a more reproducible way.</html:p>
            <html:p>To get started with Shelter, you can read the <fr:link href="/shelter-0003/" title="Getting Started" uri="https://shelter.sirref.org/shelter-0003/" display-uri="shelter-0003" type="local">getting started</fr:link> tutorial. For a more thorough understanding of what Shelter offers and how to use it, then please follow the <fr:link href="/shelter-0004/" title="Documentation" uri="https://shelter.sirref.org/shelter-0004/" display-uri="shelter-0004" type="local">documentation</fr:link>.</html:p>
            <fr:tree show-metadata="false" expanded="false" numbered="false">
              <fr:frontmatter>
                <fr:authors />
                <fr:date>
                  <fr:year>2025</fr:year>
                  <fr:month>7</fr:month>
                  <fr:day>21</fr:day>
                </fr:date>
                <fr:uri>https://shelter.sirref.org/shelter-0001/</fr:uri>
                <fr:display-uri>shelter-0001</fr:display-uri>
                <fr:route>/shelter-0001/</fr:route>
                <fr:title text="About Shelter's Documentation">About Shelter's Documentation</fr:title>
              </fr:frontmatter>
              <fr:mainmatter>
                <html:p>Shelter's documentation is written in using <fr:link href="https://forester-notes.org/" type="external">Forester</fr:link> via <fr:link href="https://graft.sirref.org/" type="external">Graft</fr:link>.</html:p>
                <html:p>The main ethos is to divide the documentation into fairly small, standalone chunks. These can then be pieced together into documentation pages that are tightly linked.</html:p>
              </fr:mainmatter>
            </fr:tree>
            <html:p>For reference documentation, we have:</html:p>
            <html:ul>
              <html:li>
                <html:p>The <fr:link href="/shelterfile-syntax/" title="Shelterfile Syntax" uri="https://shelter.sirref.org/shelterfile-syntax/" display-uri="shelterfile-syntax" type="local">Shelterfile syntax</fr:link> -- the syntax for shelterfiles, a mishmash of Dockerfiles and shell scripts. These are useful for setting up branches for developement <![CDATA[or running (modest) pipelines.]]></html:p>
              </html:li>
              <html:li>
                <html:p>The available <fr:link href="/shelter-0002/" title="Shelter Meta-commands" uri="https://shelter.sirref.org/shelter-0002/" display-uri="shelter-0002" type="local">meta-commands</fr:link> -- these extend past shell scripts and allow users to access the more <html:em>interesting</html:em> parts of Shelter like <html:code>@ undo</html:code> or <html:code>@ merge &lt;branch&gt;</html:code> for example.</html:p>
              </html:li>
              <html:li>
                <html:p>The <fr:link href="/logs/" title="Shelter Logs" uri="https://shelter.sirref.org/logs/" display-uri="logs" type="local">development logs</fr:link> -- a set of developer logs about the activity on shelter.</html:p>
              </html:li>
            </html:ul>
          </fr:mainmatter>
        </fr:tree>
      </fr:mainmatter>
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Related">Related</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Contributions">Contributions</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
  </fr:backmatter>
</fr:tree>
