*View this file with results and syntax highlighting [here](https://mlochbaum.github.io/BQN/doc/index.html).*

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

Overview:
- [Syntax](syntax.md)
- [Types](types.md)
- [Primitives](primitive.md)

Concepts:
- [Based array theory](based.md)
- [Blocks](block.md) (including function and modifier definition)
- [Context-free grammar](context.md)
- [Functional programming](functional.md)
- [Array indices](indices.md)
- [The leading axis model](leading.md)

Primitives:
- [Array depth](depth.md) (`≡` and `⚇`)
- [Group](group.md) (`⊔`)
- [Join](join.md) (`∾`)
- [Logical functions](logic.md) (`∧∨¬`)
- [Prefixes and Suffixes](prefixes.md) (`↑↓`)
- [Shift functions](shift.md) (`»«`)
- [Solo, Couple, and Merge](couple.md) (`≍>`)
- [Transpose](transpose.md) (`⍉`)
- [Windows](windows.md) (`↕`)

References:
- [Glossary](glossary.md)
- [BQN-Dyalog dictionary](fromDyalog.md)

Speculation:
- [Possible language extensions](extensions.md)