diff options
| author | Marshall Lochbaum <mwlochbaum@gmail.com> | 2020-07-18 11:01:23 -0400 |
|---|---|---|
| committer | Marshall Lochbaum <mwlochbaum@gmail.com> | 2020-07-18 11:01:23 -0400 |
| commit | 920e5f624551f7b63b590cb0d6c0a6366a45fca2 (patch) | |
| tree | 2141896274ec901d634f4c4d82d1a0e1cf2ba721 | |
| parent | 915c912d5c5a645ae268e9088968946e851d5b9e (diff) | |
Add index for doc/ folder
| -rw-r--r-- | doc/README.md | 19 | ||||
| -rw-r--r-- | docs/doc/index.html | 23 | ||||
| -rw-r--r-- | docs/spec/index.html | 2 | ||||
| -rw-r--r-- | spec/README.md | 2 |
4 files changed, 44 insertions, 2 deletions
diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..8636b23c --- /dev/null +++ b/doc/README.md @@ -0,0 +1,19 @@ +# 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: + +Concepts: +- [Context-free grammar](context.md) +- [Functional programming](functional.md) +- [Array indices](indices.md) + +Primitives: +- [Array depth](depth.md) (`≡` and `⚇`) +- [Group](group.md) (`⊔`) +- [Join](join.md) (`∾`) +- [Logical functions](logic.md) (`∧∨¬`) +- [Transpose](transpose.md) (`⍉`) +- [Windows](windows.md) (`↕`) + +References: +- [BQN-Dyalog dictionary](fromDyalog.md) diff --git a/docs/doc/index.html b/docs/doc/index.html new file mode 100644 index 00000000..972611f6 --- /dev/null +++ b/docs/doc/index.html @@ -0,0 +1,23 @@ +<head><link href="../style.css" rel="stylesheet"/></head> +<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>Concepts:</p> +<ul> +<li><a href="context.html">Context-free grammar</a></li> +<li><a href="functional.html">Functional programming</a></li> +<li><a href="indices.html">Array indices</a></li> +</ul> +<p>Primitives:</p> +<ul> +<li><a href="depth.html">Array depth</a> (<code><span class='Function'>≡</span></code> and <code><span class='Composition'>⚇</span></code>)</li> +<li><a href="group.html">Group</a> (<code><span class='Function'>⊔</span></code>)</li> +<li><a href="join.html">Join</a> (<code><span class='Function'>∾</span></code>)</li> +<li><a href="logic.html">Logical functions</a> (<code><span class='Function'>∧∨¬</span></code>)</li> +<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="fromDyalog.html">BQN-Dyalog dictionary</a></li> +</ul> + diff --git a/docs/spec/index.html b/docs/spec/index.html index 6a4ba53f..17a06dd4 100644 --- a/docs/spec/index.html +++ b/docs/spec/index.html @@ -1,6 +1,6 @@ <head><link href="../style.css" rel="stylesheet"/></head> <h1 id="bqn-specification">BQN specification</h1> -<p>This directory gives a (currently incomplete) specification for BQN. The specification differs from the documentation in <code><span class='Value'>doc</span><span class='Function'>/</span></code> in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives.</p> +<p>This directory gives a (currently incomplete) specification for BQN. The specification differs from the <a href="../doc/index.html">documentation</a> in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives.</p> <p>The following aspects define BQN and are or will be specified:</p> <ul> <li><a href="types.html">Types</a></li> diff --git a/spec/README.md b/spec/README.md index 087d3358..e1039865 100644 --- a/spec/README.md +++ b/spec/README.md @@ -1,6 +1,6 @@ # BQN specification -This directory gives a (currently incomplete) specification for BQN. The specification differs from the documentation in `doc/` in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives. +This directory gives a (currently incomplete) specification for BQN. The specification differs from the [documentation](../doc/README.md) in that its purpose is only to describe the exact details of BQN's operation in the most quickly accessible way, rather than to explain the core ideas of BQN functionality and how it might be used. Since it is easier to specify than to document, the specification is currently more complete than the documentation; for example, it includes nearly all primitives. The following aspects define BQN and are or will be specified: - [Types](types.md) |