Update links to docs; create an index with them

byexamples · Nov 29, 2018 · 6f75b4f · 6f75b4f
1 parent bc59213
commit 6f75b4f
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -54,9 +54,9 @@ $ byexample -l python,ruby,shell README.md      # run it    # byexample: +skip
 ```
 
 You can select which languages to run, over which files, how to display the
-[differences](https://byexamples.github.io/byexample/differences) and much more.
+[differences](https://byexamples.github.io/byexample/overview/differences) and much more.
 
-The [usage](https://byexamples.github.io/byexample/usage)
+The [usage](https://byexamples.github.io/byexample/overview/usage)
 document goes through almost all the flags that
 ``byexample`` program has, full of examples of course.
 
@@ -106,10 +106,10 @@ an interpreter session like example.
 
 Take a look to the documentation of each language [docs/languages](https://github.com/byexamples/byexample/tree/master/docs/languages/).
 
-Check out [where should I write the examples](https://byexamples.github.io/byexample/where-should-I-write-the-examples)
+Check out [where should I write the examples](https://byexamples.github.io/byexample/overview/where-should-I-write-the-examples)
 section, it has a more in deep description.
 
-And also check the [usage](https://byexamples.github.io/byexample/usage) page
+And also check the [usage](https://byexamples.github.io/byexample/overview/usage) page
 for more examples.
 
 ## Languages supported
@@ -148,8 +148,8 @@ It is possible to extend ``byexample`` adding new ways to find examples in a
 document and/or to parse and run/interpret a new language or adding hooks to be
 called regardless of the language/interpreter.
 
-Check out [how to support new finders and languages](https://byexamples.github.io/byexample/how-to-support-new-finders-and-languages)
-and [how to hook to events with concerns](https://byexamples.github.io/byexample/how-to-hook-to-events-with-concerns) for
+Check out [how to support new finders and languages](https://byexamples.github.io/byexample/contrib/how-to-support-new-finders-and-languages)
+and [how to hook to events with concerns](https://byexamples.github.io/byexample/contrib/how-to-hook-to-events-with-concerns) for
 a quick tutorials that shows exactly how to do that.
 
 You could also share your work and [contribute](https://github.com/byexamples/byexample/tree/master/CONTRIBUTING.md) to

diff --git a/docs/advanced/unicode.md b/docs/advanced/unicode.md
@@ -68,7 +68,7 @@ Differences:
 <...>
 ```
 
-**Note:** the [``ndiff`` algorithm](docs/basic/differences.md)
+**Note:** the [``ndiff`` algorithm](docs/overview/differences.md)
 will not put the marker ``+`` in the correct position
 if the characters are *wide characters*.
 

diff --git a/docs/contrib/how-to-support-new-finders-and-languages.md b/docs/contrib/how-to-support-new-finders-and-languages.md
@@ -31,7 +31,7 @@ The first thing to teach ``byexample`` is how to find a ``ArnoldC``
 example.
 
 ``byexample`` already has a generic finder, the
-[fenced code block finder](docs/usage/where-should-I-write-the-examples.md).
+[fenced code block finder](docs/overview/where-should-I-write-the-examples.md).
 
 But just for fun, let's imagine that we want to do something different.
 Let's say that our examples are enclosed by the ``~~~`` strings: anything
@@ -148,7 +148,7 @@ part of the example:
 ```
 
 Check also how this is
-[seen and used](docs/usage/where-should-I-write-the-examples.md)
+[seen and used](docs/overview/where-should-I-write-the-examples.md)
 by the user of your new language.
 
 ### Detect the language

diff --git a/docs/idx.md b/docs/idx.md
@@ -0,0 +1,33 @@
+# Quick Overview
+[Quick usage](docs/overview/usage.md)
+[Where should I write the examples?](docs/overview/where-should-I-write-the-examples.md)
+[Showing the Differences](docs/overview/differences.md)
+
+# Basics Options
+[Byexample Options](docs/basic/options.md)
+
+[Setup and Tear Down](docs/basic/setup-and-tear-down.md)
+[Capture and Paste](docs/basic/capture-and-paste.md)
+[Skip and Pass](docs/basic/skip-and-pass.md)
+[Example Timeout](docs/basic/timeout.md)
+[Normalize Whitespace](docs/basic/normalize-whitespace.md)
+
+# Advanced Options
+[Terminal Geometry](docs/advanced/geometry.md)
+[Greedy and Lazy Tags](docs/advanced/greedy-lazy-tags.md)
+[Shebang](docs/advanced/shebang.md)
+[Terminal Emulation](docs/advanced/terminal-emulation.md)
+[Unicode Support](docs/advanced/unicode.md)
+
+# How to Contribute
+[Add New Languages](docs/contrib/how-to-support-new-finders-and-languages.md)
+[Hook to Events](docs/contrib/how-to-hook-to-events-with-concerns.md)
+[Contribute Guidelines](https://github.com/byexamples/byexample/tree/master/CONTRIBUTING.md)
+
+# Languages Supported
+[Python](docs/languages/python.md)
+[Ruby](docs/languages/ruby.md)
+[Javascript](docs/languages/javascript.md)
+[Shell](docs/languages/shell.md)
+[GDB](docs/languages/gdb.md)
+[C/C++](docs/languages/cpp.md)
diff --git a/docs/languages/python.md b/docs/languages/python.md
@@ -209,7 +209,7 @@ See [norm-ws](docs/basic/normalize-whitespace.md),
 [tags](docs/basic/capture-and-paste.md),
 [skip](docs/basic/skip-and-pass.md),
 [pass](docs/basic/skip-and-pass.md) and
-[diff](docs/basic/differences.md) for more info.
+[diff](docs/overview/differences.md) for more info.
 
 ## Pretty print display hook
 

diff --git a/docs/basic/differences.md → docs/overview/differences.md b/docs/basic/differences.md → docs/overview/differences.md
diff --git a/docs/usage/usage.md → docs/overview/usage.md b/docs/usage/usage.md → docs/overview/usage.md
diff --git a/...sage/where-should-I-write-the-examples.md → ...view/where-should-I-write-the-examples.md b/...sage/where-should-I-write-the-examples.md → ...view/where-should-I-write-the-examples.md