diff --git a/.gitignore b/.gitignore index a57226e..99d3fbe 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,4 @@ _build/ docs/ example/ stable/ +_book/ diff --git a/README.md b/README.md index 29882ee..56c3c26 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ npm install -g elchemy Elchemy lets you write simple, fast and quality type safe code while leveraging both the Elm's safety and Elixir's ecosystem ## [You can test Elchemy online here](http://elchemy-live.herokuapp.com/) or here [Old (stable, no type checking) version](https://wende.github.io/elchemy/stable) -## [You can read Elchemy documentation here](roadmap/README.md) +## [You can read Elchemy documentation here](https://wende.gitbooks.io/elchemy/content/) ## [You can read a tutorial on using Elchemy here](https://medium.com/@krzysztof.wende/elmchemy-write-type-safe-elixir-code-with-elms-syntax-part-1-introduction-8968b76d721d) ### In case of any questions about the project feel free to submit them in Issues with Q&A label diff --git a/book.json b/book.json new file mode 100644 index 0000000..9328c5e --- /dev/null +++ b/book.json @@ -0,0 +1,3 @@ +{ + "root" : "./roadmap" +} diff --git a/roadmap/README.md b/roadmap/README.md index 2910a58..e1a1f56 100644 --- a/roadmap/README.md +++ b/roadmap/README.md @@ -1,6 +1,6 @@ -# Roadmap +# Elchemy -This folder lists all of the ideas and solutions behind Elchemy to share the +This page lists all of the ideas and solutions behind Elchemy to share the ideology as well as existing and incoming solutions to problems this project faced or eventually will have to face diff --git a/roadmap/SUMMARY.md b/roadmap/SUMMARY.md new file mode 100644 index 0000000..d3de708 --- /dev/null +++ b/roadmap/SUMMARY.md @@ -0,0 +1,20 @@ +# Summary + +### Documentation +* [Table Of Contents](./README.md) +* [Installations](./INSTALLATION.md) +* Basics + * [Basic Types](./BASIC_TYPES.md) + * [Defining Types](./TYPES.md) + * [Defining Type Aliases](./TYPE_ALIASES.md) + * [Defining Structures](./STRUCTURES.md) + * [Defining Modules](./MODULES.md) + * [Defining Functions](./FUNCTIONS.md) + * [Comments](./COMMENTS.md) +* Advanced + * [Side Effects / TEA](./SIDE_EFFECTS.md) + * [Unit Testing](./TESTING.md) + * [Compiler Flags](./FLAGS.md) + * [Inlining Elixir](./INLINING.md) +* Tooling + * [Troubleshooting](./TROUBLESHOOTING.md)