From 920e5f624551f7b63b590cb0d6c0a6366a45fca2 Mon Sep 17 00:00:00 2001 From: Marshall Lochbaum Date: Sat, 18 Jul 2020 11:01:23 -0400 Subject: Add index for doc/ folder --- doc/README.md | 19 +++++++++++++++++++ docs/doc/index.html | 23 +++++++++++++++++++++++ docs/spec/index.html | 2 +- spec/README.md | 2 +- 4 files changed, 44 insertions(+), 2 deletions(-) create mode 100644 doc/README.md create mode 100644 docs/doc/index.html 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 @@ + +

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, the documentation is much less complete. The following pages are present now:

+

Concepts:

+ +

Primitives:

+ +

References:

+ + 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 @@

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 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: