Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make all pages accessible without going through the navigation menu #131

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/README.juvix.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Discord][anomaDiscord]. -->

[:octicons-arrow-right-24: Quick start](./howto/quick-start.md)

[:octicons-arrow-right-24: How-to guides](./howto/installing.md)
[:octicons-arrow-right-24: How-to guides](./howto/README.md)

- :material-clock-fast:{ .lg .middle } __Tutorials__

Expand All @@ -86,6 +86,8 @@ Discord][anomaDiscord]. -->

[:octicons-arrow-right-24: Functional programming with Juvix](./tutorials/learn.html)

[:octicons-arrow-right-24: Tutorials](./tutorials/README.md)

- :fontawesome-solid-video:{ .lg .middle } __Talks and Workshops__

---
Expand All @@ -99,10 +101,14 @@ Discord][anomaDiscord]. -->

---

Explore the Language reference, milestone examples, and tooling
Explore the language reference, milestone examples, and tooling
documentation!

[:octicons-arrow-right-24: Reference](./reference/language/README.md)
[:octicons-arrow-right-24: Reference](./reference/README.md)

[:octicons-arrow-right-24: Standard library](https://anoma.github.io/juvix-stdlib/index.html)

[:octicons-arrow-right-24: Packages and projects](./juvix-packages.md)

- :material-account-group:{ .lg .middle } __Blog__

Expand Down
14 changes: 14 additions & 0 deletions docs/howto/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
icon: material/label-outline
comments: false
search:
boost: 4
hide:
- toc
---

- [Installing Juvix](./installing.md)
- [Compiling programs](./compilation.md)
- [Setting up a project](./project.md)
- [Contributing](./contributing.md)
- [Judoc documentation tool](./judoc.md)
46 changes: 46 additions & 0 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
icon: material/label-outline
comments: false
search:
boost: 4
hide:
- toc
---

## Language reference

- [Functions](./language/functions.html)
- [Builtins](./language/builtins.html)
- [Data types](./language/datatypes.html)
- [Records](./language/records.html)
- [Traits](./language/traits.html)
- [Modules](./language/modules.md)
- [Local definitions](./language/lets.html)
- [Control structures](./language/control.html)
- [Comments](./language/comments.md)
- [Pragmas](./language/pragmas.html)
- [Axioms](./language/axioms.html)

### Syntax extensions

- [Aliases](./language/aliases.html)
- [Iterators](./language/iterators.md)
- [Fixities](./language/fixity.html)
- [Operators](./language/operators.html)

### Libraries and projects

- [Standard library](./stdlib.md)
- [Example programs](./examples.md)

## Tooling

- [Documentation tool](./judoc.md)
- [Command line interface](./tooling/CLI.md)
- [Doctor](./tooling/doctor.md)
- [Emacs mode](./tooling/emacs.md)
- [Haskell test suite](./tooling/testing.md)

## Compiler implementation

- [Compiler pipeline](./compiler.md)
44 changes: 35 additions & 9 deletions docs/reference/language/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,40 @@ hide:
- toc
---

Juvix is designed with a focus on safety. The Juvix compiler runs several
static analyses which guarantee the absence of runtime errors. Analyses
performed include termination and type checking.
## Language reference

The Juvix module system allows developers to break down their programs into
smaller, reusable modules that can be compiled separately and combined to create
larger programs. These modules can be used to build libraries, which can then be
documented using Juvix's built-in documentation generation tool, see for
example, [the Juvix standard library's website][stdlib].
- [Functions](../language/functions.html)
- [Builtins](../language/builtins.html)
- [Data types](../reference/language/datatypes.juvix.md)
- [Records](./reference/language/records.juvix.md)
- [Traits](./reference/language/traits.juvix.md)
- [Modules](./reference/language/modules.md)
- [Local definitions](./reference/language/lets.juvix.md)
- [Control structures](./reference/language/control.juvix.md)
- [Comments](./reference/language/comments.md)
- [Pragmas](./reference/language/pragmas.juvix.md)
- [Axioms](./reference/language/axioms.juvix.md)

[stdlib]: https://anoma.github.io/juvix-stdlib/
### Syntax extensions

- [Aliases](./reference/language/aliases.juvix.md)
- [Iterators](./reference/language/iterators.md)
- [Fixities](./reference/language/fixity.juvix.md)
- [Operators](./reference/language/operators.juvix.md)

### Libraries and projects

- [Standard library](./reference/stdlib.md)
- [Example programs](./reference/examples.md)

## Tooling

- [Documentation tool](./reference/judoc.md)
- [Command line interface](./reference/tooling/CLI.md)
- [Doctor](./reference/tooling/doctor.md)
- [Emacs mode](./reference/tooling/emacs.md)
- [Haskell test suite](./reference/tooling/testing.md)

## Compiler implementation

- [Compiler pipeline](./reference/compiler.md)
12 changes: 12 additions & 0 deletions docs/tutorials/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
icon: material/label-outline
comments: false
search:
boost: 4
hide:
- toc
---

- [Functional programming with Juvix](./learn.html)
- [Juvix VSCode extension](./vscode.html)
- [Juvix Emacs mode](./emacs.html)
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,20 +133,22 @@ nav:
- ./README.juvix.md

- How-to guides:
- How-to guides: ./howto/README.md
- Installing Juvix: ./howto/installing.md
- Compiling programs: ./howto/compilation.md
- Setting up a project: ./howto/project.md
- Contributing: ./howto/contributing.md
- Judoc documentation tool: ./howto/judoc.md

- Tutorials:
- Tutorials: ./tutorials/README.md
- Functional programming with Juvix: ./tutorials/learn.juvix.md
- Juvix VSCode extension: ./tutorials/vscode.juvix.md
- Juvix Emacs mode: ./tutorials/emacs.juvix.md

- Reference:
- Language reference:
- About: ./reference/language/README.md
- Reference: ./reference/README.md
- Functions: ./reference/language/functions.juvix.md
- Builtins: ./reference/language/builtins.juvix.md
- Data types: ./reference/language/datatypes.juvix.md
Expand Down
Loading