More documentation tweaks

docs/abi/calling-convention.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Millfork calling convention
 

docs/abi/generated-labels.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Guide to generated label names
 

docs/abi/inlining.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Macros and inlining
 

docs/abi/undefined-behaviour.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Undefined behaviour
 

docs/abi/undocumented.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Undocumented opcodes
 

docs/abi/variable-storage.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Variable storage
 

docs/api/apple2-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### A note about Apple II
 

docs/api/bbcmicro-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### A note about BBC Micro
 

docs/api/command-line.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Command-line options
 

docs/api/commodore-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### A note about Commodore 64
 

docs/api/cpc-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### A note about Amstrad CPC
 

docs/api/custom-platform.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## Adding a custom platform
 

docs/api/famicom-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Famicom/NES programming guide
 

docs/api/gb-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Game Boy programming guide
 

docs/api/getting-started.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Getting started
 

docs/api/lunix-programming-guide.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### A note about LUnix
 

docs/api/rom-vs-ram.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ### ROM vs RAM targets
 

docs/api/target-platforms.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
                                                       
 # Target platforms
 

docs/doc_index.md

@@ -0,0 +1,82 @@
+# Documentation index
+
+* [Home page](index.md)
+
+## Compiler usage
+
+* [Getting started](api/getting-started.md)
+
+* [Command-line option reference](api/command-line.md)
+
+* [Target platform reference](api/target-platforms.md)
+
+* [Defining a custom platform](api/custom-platform.md)
+
+## Language reference
+
+* [Preprocessor](lang/preprocessor.md)
+
+* [Syntax](lang/syntax.md)
+
+* [Types](lang/types.md)
+
+* [Literals](lang/literals.md)
+
+* [List of text encodings and escape sequences](lang/text.md)
+
+* [Operators reference](lang/operators.md)
+
+* [Functions](lang/functions.md)
+
+* [Inline 6502 assembly syntax](lang/assembly.md)
+
+* [Inline 8080/LR35902/Z80 assembly syntax](lang/assemblyz80.md)
+
+* [Important guidelines regarding reentrancy](lang/reentrancy.md)
+
+## Library reference
+
+* [`stdlib` module](stdlib/stdlib.md)
+
+* [`string` module](stdlib/string.md)
+
+* [`stdio` module](stdlib/stdio.md)
+
+* [Modules for reading input devices](stdlib/input.md)
+
+* [Other cross-platform modules (`keyboard`, `err`, `random`)](stdlib/other.md)
+
+* [Definitions available on only some platforms](stdlib/frequent.md)
+
+* [C64-only modules](stdlib/c64.md)
+
+* [`cbm_file` module](stdlib/cbm_file.md)
+
+* [NES-only modules](stdlib/nes.md)
+
+* [Game Boy–only modules](stdlib/gb.md)
+
+## Implementation details
+
+* [Variable storage](abi/variable-storage.md)
+
+* [Calling convention](abi/calling-convention.md)
+
+* [Undefined behaviour](abi/undefined-behaviour.md)
+
+* [Undocumented instruction support](abi/undocumented.md)
+
+* [Reference for labels in generated assembly code](abi/generated-labels.md)
+
+## External links
+
+* [Example programs](https://github.com/KarolS/millfork/tree/master/examples)
+
+* [Millfork wiki](https://github.com/KarolS/millfork/wiki)
+
+* [Benchmarks](https://github.com/KarolS/millfork-benchmarks)
+
+* [Downloads](https://github.com/KarolS/millfork/releases/)  
+
+* [Source code](https://github.com/KarolS/millfork)
+

docs/index.md

@@ -4,7 +4,7 @@
 
 Millfork focuses on performance, compactness, simplicity and readability.
 
-* [**Documentation index**](README.md)
+* [**Documentation index**](doc_index.md)
 
 * [**Getting started**](api/getting-started.md)
 

docs/lang/assembly.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Using 6502 assembly within Millfork programs
 

docs/lang/assemblyz80.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Using 8080/LR35902/Z80 assembly within Millfork programs
 

docs/lang/functions.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Function definitions
 

docs/lang/interfacing.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Interfacing with external code 
 

docs/lang/literals.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Literals and initializers
 

docs/lang/operators.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Operators
 

docs/lang/preprocessor.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Preprocessor
 

docs/lang/reentrancy.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Reentrancy
 

docs/lang/syntax.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Syntax
 

docs/lang/text.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Text encodings ans escape sequences
 

docs/lang/types.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Types
 

docs/lang/x86disclaimer.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # 8086 support disclaimer
 

docs/stdlib/c64.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Commodore 64-oriented modules
 

docs/stdlib/cbm_file.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## cbm_file
 

docs/stdlib/frequent.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 Definitions on the following list are frequently provided by the default automatically-imported modules. 
 

docs/stdlib/gb.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Game Boy–oriented modules
 

docs/stdlib/input.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## joy
 

docs/stdlib/nes.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # NES/Famicom-oriented modules
 

docs/stdlib/other.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## keyboard
 

docs/stdlib/stdio.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## stdio
 

docs/stdlib/stdlib.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## stdlib
 

docs/stdlib/string.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 ## string
 

docs/various/faq.md

@@ -1,4 +1,4 @@
-[< back to index](../README.md)
+[< back to index](../doc_index.md)
 
 # Frequently Asked Questions
 

mkdocs.yml

@@ -2,7 +2,7 @@ site_name: Millfork documentation
 theme: readthedocs
 nav:
   - Home: index.md
-  - Index: README.md
+  - Index: doc_index.md
   - FAQ: various/faq.md
   - User guide:
     - Getting started: api/getting-started.md