Skip to content

Commit

Permalink
Add index files for all subdirectories
Browse files Browse the repository at this point in the history
  • Loading branch information
Zollerboy1 committed Jul 24, 2022
1 parent 9b62ada commit af93081
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# The *juice* Programming Language Documentation

This repository contains the documentation of the *juice* programing language that can be viewed on its [website](https://juicelang.org/docs).
This repository contains the documentation of the *juice* programming language that can be viewed on its [website](https://juicelang.org/docs).

It is subdivided into the following categories:

Expand Down
4 changes: 4 additions & 0 deletions compiler-documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# The *juice* Programming Language Compiler Documentation

The compiler documentation will eventually contain some information about the inner workings of the *juice* compiler. For example, you'll find an overview over the compiler pipeline and some more specific documents like a short description of how the type-checker works.
However, since there is still a lot of progress to be made before the compiler will be anywhere near production ready, this section of the documentation will remain empty for now.
4 changes: 4 additions & 0 deletions language-guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# The *juice* Programming Language Guide

In the future, the language guide will provide a simple and easy to follow intro for people new to the *juice* programming language. It will give a quick overview over most important programming concepts and how they are handled in *juice*.
For now, this part of the documentation remains empty, but it will become a high priority as soon as the language reaches a somewhat usable state.
3 changes: 3 additions & 0 deletions stdlib-reference/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# The *juice* Standard Library Reference

The complete API reference and documentation of the *juice* standard library will have its place here, as soon as it gets into the focus of the development. There isn't even any standard library available yet, so this part of the documentation stays empty for now.

0 comments on commit af93081

Please sign in to comment.