Merge pull request #191 from NotAShelf/docs-markdown-rln

docs/manual: convert release notes to markdown

docs/manual.nix

@@ -10,11 +10,10 @@
 }:
 stdenv.mkDerivation {
   name = "neovim-flake-manual";
+  src = ./manual;
 
   nativeBuildInputs = [nixos-render-docs];
 
-  src = ./manual;
-
   buildPhase = ''
     mkdir -p out/media
 
@@ -35,9 +34,11 @@ stdenv.mkDerivation {
         '@VERSION@' \
         ${revision}
 
-    cp ${nmd}/static/style.css out/style.css
-    cp -t out/highlightjs ${nmd}/static/highlightjs/tomorrow-night.min.css
-    cp ${./highlight-style.css} out/highlightjs/highlight-style.css
+    cp -v ${nmd}/static/style.css out/style.css
+    cp -vt out/highlightjs ${nmd}/static/highlightjs/tomorrow-night.min.css
+    cp -v ${./highlight-style.css} out/highlightjs/highlight-style.css
+
+    cp -vr ${./release-notes} release-notes
 
     nixos-render-docs manual html \
       --manpage-urls ./manpage-urls.json \

docs/manual/default-configs/maximal.md

@@ -6,6 +6,8 @@ $ nix shell github:notashelf/neovim-flake#maximal test.nix
 
 It is the same fully configured neovim as with the [Nix](#sec-default-nix) config, but with every supported language enabled.
 
-::: note
+:::{.note}
+
 Running the maximal config will download _a lot_ of packages as it is downloading language servers, formatters, and more.
+
 :::

docs/manual/hacking/guidelines.md

@@ -15,7 +15,10 @@ Most, if not all, changes warrant changes to the documentation. Module options s
 [Nixpkgs-flavoured Markdown](https://nixos.org/manual/nixpkgs/unstable/#sec-contributing-markup), albeit with exceptions.
 
 :::{.note}
-As of v0.6, neovim-flake is itself documented using full markdown in both module options and the manual.
+
+As of v0.5, neovim-flake is itself documented using full markdown in both module options and the manual. With
+v0.6, this manual has also been converted to markdown in full.
+
 :::
 
 The HTML version of this manual containing both the module option descriptions and the documentation of neovim-flake
@@ -44,9 +47,9 @@ a pull request should make sense both on its own and in general context. That is
 an issue that is introduced in an earlier commit. In particular, you will be asked to amend any commit that
 introduces syntax errors or similar problems even if they are fixed in a later commit.
 
-The commit messages should follow the {seven-rules}[seven rules], except for "Capitalize the subject line".
-We also ask you to include the affected code component or module in the first line.
-A commit message ideally, but not necessarily, follow the given template from home-manager's own documentation
+The commit messages should follow the [seven rules](https://chris.beams.io/posts/git-commit/#seven-rule),
+except for "Capitalize the subject line". We also ask you to include the affected code component or module in
+the first line. A commit message ideally, but not necessarily, follow the given template from home-manager's own documentation
 
 ```
   {component}: {description}
@@ -57,11 +60,11 @@ A commit message ideally, but not necessarily, follow the given template from ho
 where `{component}` refers to the code component (or module) your change affects, `{description}` is a very brief
 description of your change, and `{long description}` is an optional clarifying description. As a rare exception, if
 there is no clear component, or your change affects many components, then the `{component}` part is optional.
-See <<ex-commit-message>> for a commit message that fulfills these requirements.
+See [example commit message](#sec-guidelines-ex-commit-message) for a commit message that fulfills these requirements.
 
 ## Example Commit {#sec-guidelines-ex-commit-message}
 
-The commit {example-commit-message}[69f8e47e9e74c8d3d060ca22e18246b7f7d988ef] contains the commit message
+The commit [69f8e47e9e74c8d3d060ca22e18246b7f7d988ef](https://github.com/nix-community/home-manager/commit/69f8e47e9e74c8d3d060ca22e18246b7f7d988ef) contains the commit message
 
 ```
 

docs/manual/hacking/keybinds.md

@@ -1,13 +1,11 @@
 # Keybinds {#sec-keybinds}
 
 As of 0.4, there exists an API for writing your own keybinds and a couple of useful utility functions are available in
-the https://github.com/NotAShelf/neovim-flake/tree/main/lib[extended standard library]. The following section contains
+the [extended standard library](https://github.com/NotAShelf/neovim-flake/tree/main/lib). The following section contains
 a general overview to how you may utilize said functions.
 
 ## Custom Key Mappings Support for a Plugin {#sec-custom-key-mappings}
 
-:maps: https://notashelf.github.io/neovim-flake/options.html#opt-vim.maps.command._name_.action
-
 To set a mapping, you should define it in `vim.maps.<<mode>>`.
 The available modes are:
 
@@ -37,7 +35,9 @@ An example, simple keybinding, can look like this:
 }
 ```
 
-There are many settings available in the options. Please refer to the {maps}[documentation] to see a list of them.
+There are many settings available in the options. Please refer to the
+[documentation](https://notashelf.github.io/neovim-flake/options.html#opt-vim.maps.command._name_.action)
+to see a list of them.
 
 `neovim-flake` provides a list of helper commands, so that you don't have to write the mapping attribute sets every
 time:

docs/manual/manual.md

@@ -20,3 +20,7 @@ hacking.md
 ```{=include=} appendix html:into-file=//options.html
 options.md
 ```
+
+```{=include=} appendix html:into-file=//release-notes.html
+release-notes/release-notes.md
+```

docs/release-notes/release-notes.md

@@ -0,0 +1,12 @@
+# Release Notes {#ch-release-notes}
+
+This section lists the release notes for tagged version of neovim-flake and current main.
+
+```{=include=} chapters
+rl-0.1.md
+rl-0.2.md
+rl-0.3.md
+rl-0.4.md
+rl-0.5.md
+rl-0.6.md
+```

docs/release-notes/rl-0.1.md

@@ -0,0 +1,40 @@
+# Release 0.1 {#sec-release-0.1}
+
+This is the current master branch and information here is not final. These are changes from the v0.01 tag.
+
+Special thanks to [home-manager](https://github.com/nix-community/home-manager/) for this release.
+Docs/manual generation, the new module evaluation system, and DAG implementation are from them.
+
+## Changelog {#sec-release-0.1-changelog}
+
+[jordanisaacs](https://github.com/jordanisaacs):
+
+- Removed hare language support (lsp/tree-sitter/etc). `vim.lsp.hare` is no longer defined.
+  If you use hare and would like it added back, please file an issue.
+
+- [vim.stratPlugins](opt-vim.startPlugins) & [vim.optPlugins](opt-vim.optPlugins) are now
+  an enum of `string` for options sourced from the flake inputs. Users can still provide vim
+  plugin packages.
+
+  - If you are contributing and adding a new plugin, add the plugin name to `availablePlugins` in
+    [types-plugin.nix](https://github.com/jordanisaacs/neovim-flake/blob/20cec032bd74bc3d20ac17ce36cd84786a04fd3e/modules/lib/types-plugin.nix).
+
+- `neovimBuilder` has been removed for configuration. Using an overlay is no longer required.
+  See the manual for the new way to configuration.
+
+- Treesitter grammars are now configurable with [vim.treesitter.grammars](opt-vim.treesitter.grammars).
+  Utilizes the nixpkgs `nvim-treesitter` plugin rather than a custom input in order to take advantage of build support of pinned versions.
+  See [relevant discourse post](https://discourse.nixos.org/t/psa-if-you-are-on-unstable-try-out-nvim-treesitter-withallgrammars/23321?u=snowytrees)
+  for more information. Packages can be found under the `vimPlugins.nvim-treesitter.builtGrammars` namespace.
+
+- [vim.configRC](opt-vim.configRC) and [vim.luaConfigRC](opt-vim.luaConfigRC) are now of type DAG lines.
+  This allows for ordering of the config. Usage is the same is in home-manager's `home.activation` option.
+
+```nix
+vim.luaConfigRC = lib.nvim.dag.entryAnywhere "config here"
+```
+
+[MoritzBoehme](https://github.com/MoritzBoehme):
+
+- `catppuccin` theme is now available as a neovim theme [vim.theme.style](opt-vim.theme.style) and lualine theme
+  [vim.statusline.lualine.theme](opt-vim.statusline.lualine.theme).

docs/release-notes/rl-0.2.md

@@ -0,0 +1,53 @@
+# Release 0.2 {#sec-release-0.2}
+
+Release notes for release 0.2
+
+## Changelog {#sec-release-0.2-changelog}
+
+[notashelf](https://github.com/notashelf):
+
+- Added two minimap plugins under `vim.minimap`. `codewindow.nvim` is enabled by default, while `minimap.vim` is
+  available with its code-minimap dependency.
+- A complementary plugin, `obsidian.nvim` and the Neovim alternative for Emacs' orgmode with `orgmode.nvim` have been
+  added. Both will be disabled by default.
+
+- Smooth scrolling for ANY movement command is now available with `cinnamon.nvim`
+
+- You will now notice a dashboard on startup. This is provided by the `alpha.nvim` plugin. You can use any of the
+  three available dashboard plugins, or disable them entirely.
+
+- There is now a scrollbar on active buffers, which can highlight errors by hooking to your LSPs. This is on by
+  default, but can be toggled off under `vim.visuals` if seen necessary.
+
+- Discord Rich Presence has been added through `presence.nvim` for those who want to flex that they are using
+  the _superior_ text editor.
+
+- An icon picker is now available with telescope integration. You can use `:IconPickerInsert` or `:IconPickerYank`
+  to add icons to your code.
+
+- A general-purpose cheatsheet has been added through `cheatsheet.nvim`. Forget no longer!
+
+- `ccc.nvim` has been added to the default plugins to allow picking colors with ease.
+
+- Most UI components of Neovim have been replaced through the help of `noice.nvim`. There are also notifications
+  and custom UI elements available for Neovim messages and prompts.
+
+- A (floating by default) terminal has been added through `toggleterm.nvim`.
+
+- Harness the power of ethical (`tabnine.nvim`) and not-so-ethical (`copilot.lua`) AI by those new assistant plugins.
+  Both are off by default, TabNine needs to be wrapped before it's working.
+
+- Experimental mouse gestures have been added through `gesture.nvim`. See plugin page and the relevant module for
+  more details on how to use.
+
+- Re-open last visited buffers via `nvim-session-manager`. Disabled by default as deleting buffers seems to be
+  problematic at the moment.
+
+- Most of NvimTree's configuration options have been changed with some options being toggled to off by default.
+
+- Lualine had its configuration simplified and style toned down. Less color, more info.
+
+- Modules where multiple plugin configurations were in the same directory have been simplified. Each plugin inside
+  a single module gets its directory to be imported.
+
+- Separate config options with the same parent attribute have been merged into one for simplicity.