diff options
| author | Marshall Lochbaum <mwlochbaum@gmail.com> | 2021-06-06 22:07:18 -0400 |
|---|---|---|
| committer | Marshall Lochbaum <mwlochbaum@gmail.com> | 2021-06-06 22:08:08 -0400 |
| commit | c5cbdf7e335b74853314b36b9621d8e1083ac430 (patch) | |
| tree | 1d5103b5709abe98d6227d0ea6459bdca8e480c3 | |
| parent | 34c492e0e3e7cabe364112402ea92e5b7a3485c6 (diff) | |
Update documentation introduction
| -rw-r--r-- | doc/README.md | 12 | ||||
| -rw-r--r-- | docs/doc/index.html | 14 |
2 files changed, 13 insertions, 13 deletions
diff --git a/doc/README.md b/doc/README.md index acbb452c..1cd340bd 100644 --- a/doc/README.md +++ b/doc/README.md @@ -2,7 +2,7 @@ # BQN documentation -Here is the documentation for BQN, describing what features BQN has, how to use them (with examples), and why they were chosen. As it is considerably more in-depth than the [specification](../spec/README.md), the documentation is much less complete. The following pages are present now: +BQN's documentation describes what features it has, how to use them (with examples), and why they were chosen. For a linear introduction to the language, see the [tutorials](../tutorial/README.md). While the core language [specification](../spec/README.md) is complete, the documentation still has some gaps. Overview: - [Syntax](syntax.md) @@ -10,6 +10,11 @@ Overview: - [Primitives](primitive.md) - [Paradigms](paradigms.md) +References: +- [Glossary](glossary.md) +- [BQN-Dyalog dictionary](fromDyalog.md) +- [BQN-J dictionary](fromJ.md) + Concepts: - [Based array theory](based.md) - [Blocks](block.md) (including function and modifier definition) @@ -41,10 +46,5 @@ Primitives: - [Transpose](transpose.md) (`⍉`) - [Windows](windows.md) (`↕`) -References: -- [Glossary](glossary.md) -- [BQN-Dyalog dictionary](fromDyalog.md) -- [BQN-J dictionary](fromJ.md) - Environment: - [Embedded BQN](embed.md) diff --git a/docs/doc/index.html b/docs/doc/index.html index 348a8cae..e8d3c468 100644 --- a/docs/doc/index.html +++ b/docs/doc/index.html @@ -5,7 +5,7 @@ </head> <div class="nav"><a href="https://github.com/mlochbaum/BQN">BQN</a> / <a href="../index.html">main</a></div> <h1 id="bqn-documentation">BQN documentation</h1> -<p>Here is the documentation for BQN, describing what features BQN has, how to use them (with examples), and why they were chosen. As it is considerably more in-depth than the <a href="../spec/index.html">specification</a>, the documentation is much less complete. The following pages are present now:</p> +<p>BQN's documentation describes what features it has, how to use them (with examples), and why they were chosen. For a linear introduction to the language, see the <a href="../tutorial/index.html">tutorials</a>. While the core language <a href="../spec/index.html">specification</a> is complete, the documentation still has some gaps.</p> <p>Overview:</p> <ul> <li><a href="syntax.html">Syntax</a></li> @@ -13,6 +13,12 @@ <li><a href="primitive.html">Primitives</a></li> <li><a href="paradigms.html">Paradigms</a></li> </ul> +<p>References:</p> +<ul> +<li><a href="glossary.html">Glossary</a></li> +<li><a href="fromDyalog.html">BQN-Dyalog dictionary</a></li> +<li><a href="fromJ.html">BQN-J dictionary</a></li> +</ul> <p>Concepts:</p> <ul> <li><a href="based.html">Based array theory</a></li> @@ -46,12 +52,6 @@ <li><a href="transpose.html">Transpose</a> (<code><span class='Function'>⍉</span></code>)</li> <li><a href="windows.html">Windows</a> (<code><span class='Function'>↕</span></code>)</li> </ul> -<p>References:</p> -<ul> -<li><a href="glossary.html">Glossary</a></li> -<li><a href="fromDyalog.html">BQN-Dyalog dictionary</a></li> -<li><a href="fromJ.html">BQN-J dictionary</a></li> -</ul> <p>Environment:</p> <ul> <li><a href="embed.html">Embedded BQN</a></li> |
