[REVERT LATER] add ./ to relative links in CONTRIBUTING

This won't be needed if we use pandoc AST-based filters instead of dumb
substitution.

Author: MattSturgeon

CONTRIBUTING.md

@@ -30,19 +30,19 @@ This is done by making most of the options of the type `types.nullOr ....`, and
 Most of nixvim is dedicated to wrapping neovim plugins such that we can configure them in Nix.
 To add a new plugin you need to do the following.
 
-1. Add a file in the correct sub-directory of [`plugins`](plugins).
+1. Add a file in the correct sub-directory of [`plugins`](./plugins).
 
-- Most plugins should be added to [`plugins/by-name/<name>`](plugins/by-name).
+- Most plugins should be added to [`plugins/by-name/<name>`](./plugins/by-name).
   Plugins in `by-name` are automatically imported 🚀
-- Occasionally, you may wish to add a plugin to a directory outside of `by-name`, such as [`plugins/colorschemes`](plugins/colorschemes).
-  If so, you will also need to add your plugin to [`plugins/default.nix`](plugins/default.nix) to ensure it gets imported.
+- Occasionally, you may wish to add a plugin to a directory outside of `by-name`, such as [`plugins/colorschemes`](./plugins/colorschemes).
+  If so, you will also need to add your plugin to [`plugins/default.nix`](./plugins/default.nix) to ensure it gets imported.
   Note: the imports list is sorted and grouped. In vim, you can usually use `V` (visual-line mode) with the `:sort` command to achieve the desired result.
 
 2. The vast majority of plugins fall into one of those two categories:
 
 - _vim plugins_: They are configured through **global variables** (`g:plugin_foo_option` in vimscript and `vim.g.plugin_foo_option` in lua).\
   For those, you should use the `lib.nixvim.plugins.mkVimPlugin`.\
-  -> See [this plugin](plugins/by-name/direnv/default.nix) for an example.
+  -> See [this plugin](./plugins/by-name/direnv/default.nix) for an example.
 - _neovim plugins_: They are configured through a `setup` function (`require('plugin').setup({opts})`).\
   For those, you should use the `lib.nixvim.plugins.mkNeovimPlugin`.\
   -> See the [template](plugins/TEMPLATE.nix).
@@ -54,7 +54,7 @@ To add a new plugin you need to do the following.
 The `mkNeovimPlugin` function provides a standardize way to create a `Neovim` plugin.
 This is intended to be used with lua plugins that have a `setup` function,
 although it is flexible enough to be used with similar variants of plugins.
-A template plugin can be found in (plugins/TEMPLATE.nix)[https://github.com/nix-community/nixvim/blob/main/plugins/TEMPLATE.nix].
+A template plugin can be found in [`plugins/TEMPLATE.nix`](./plugins/TEMPLATE.nix).
 
 | Parameter                    | Description                                                                                                                                                                                                                                          | Required | Default Value                                                                                   |
 | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- |
@@ -113,7 +113,7 @@ thanks to package referring to the `name` attribute.
 
 See the [template](plugins/TEMPLATE.nix) for a starting point.
 
-Here's a simple plugin using `mkNeovimPlugin` for reference: [lsp_lines.nvim](plugins/by-name/lsp-lines/default.nix).
+Here's a simple plugin using `mkNeovimPlugin` for reference: [lsp_lines.nvim](./plugins/by-name/lsp-lines/default.nix).
 
 #### `mkVimPlugin`
 
@@ -214,7 +214,7 @@ In either case, you don't need to bother implementing this part. It is done auto
 
 Most of the tests of nixvim consist of creating a neovim derivation with the supplied nixvim configuration, and then try to execute neovim to check for any output. All output is considered to be an error.
 
-The tests are located in the [tests/test-sources](tests/test-sources) directory, and should be added to a file in the same hierarchy than the repository. For example if a plugin is defined in `./plugins/ui/foo.nix` the test should be added in `./tests/test-sources/ui/foo.nix`.
+The tests are located in the [tests/test-sources](./tests/test-sources) directory, and should be added to a file in the same hierarchy than the repository. For example if a plugin is defined in `./plugins/ui/foo.nix` the test should be added in `./tests/test-sources/ui/foo.nix`.
 
 Tests can either be a simple attribute set, or a function taking `{pkgs}` as an input. The keys of the set are configuration names, and the values are a nixvim configuration.
 

modules/docs/default.nix

@@ -1,4 +1,4 @@
-{ lib, ... }:
+{ lib, pkgs, ... }:
 {
   options.enableMan = lib.mkOption {
     type = lib.types.bool;
@@ -8,19 +8,29 @@
 
   imports = [
     ./_util.nix
-    ./files.nix
     ./mdbook
     ./menu
     ./options.nix
     ./pages.nix
     ./platforms.nix
+    ./user-guide.nix
   ];
 
-  config.docs.optionPages = {
-    docs = {
+  config.docs = {
+    # TODO: contributing page
+    pages."" = {
+      menu.section = "header";
+      menu.location = [ "Home" ];
+      source = pkgs.callPackage ./readme.nix {
+        # TODO: get `availableVersions` and `baseHref` from module options
+      };
+    };
+    optionPages.docs = {
       optionScopes = [ "docs" ];
       page.menu.location = [ "docs" ];
       page.text = ''
+        # docs
+
         Internal options used to construct these docs.
       '';
     };

modules/docs/files.nix

@@ -0,0 +1,37 @@
+{
+  lib,
+  pkgs,
+  ...
+}:
+let
+  user-guide = ../../docs/user-guide;
+
+  # TODO: consider configuring this as a module option?
+  # Or moving config-examples out of the user-guide directory?
+  sourceTransformers = {
+    config-examples =
+      template:
+      pkgs.callPackage ./user-configs.nix {
+        inherit template;
+      };
+  };
+in
+{
+  docs.pages = lib.concatMapAttrs (
+    name: type:
+    let
+      title = lib.removeSuffix ".md" name;
+      # Get this file's transformer, if there is one...
+      # Most user-guides we use the file as-is
+      transformer = sourceTransformers.${title} or lib.id;
+    in
+    lib.optionalAttrs (type == "regular" && lib.hasSuffix ".md" name) {
+      "user-guide/${title}" = {
+        menu.section = "user-guide";
+        # TODO: define user-facing titles to show in the menu...
+        menu.location = [ title ];
+        source = transformer "${user-guide}/${name}";
+      };
+    }
+  ) (builtins.readDir user-guide);
+}