flake: update documentation

catarina: host bonfire documentation

README.md

@@ -7,46 +7,22 @@
 <p align="center">
   <img src="https://img.shields.io/badge/nix%20flake-gray.svg?logo=nixos" alt="nix-flake"/>
   <a href="https://bonfire.cachix.org"><img src="https://img.shields.io/badge/cachix-bonfire-orange.svg" alt="bonfire-cachix" /></a>
+  <a href="https://vcs.elnafo.ru/L-Nafaryus/bonfire/actions?workflow=nix.yml"><img src="https://vcs.elnafo.ru/L-Nafaryus/bonfire/actions/workflows/nix.yml/badge.svg?branch=master&event=push" alt="nix-check" /></a>
 </p>
 
 <p align="center">
     <strong><em>Lit another Nix derivation</em></strong>
 </p>
 
-> This is a private configuration and experiment with Nix and NixOS. Formally 
-> it's a more than just a dotfiles in cause of packages, modules, templates and 
-> etc. Discover the current repository on your own risk.
+Bonfire is a slowly snowballing Nix flake with a collection of packages, NixOS modules and other cool things. 
+Of course it contains personal NixOS configurations that use all of these stuff. 
 
-# Hints 
+The main goal of this project is to keep the structure as simple as possible but use the power of Nix language on maximum (a huge field of experiments, huh?). 
 
-* Update and push inputs:
-```sh 
-nix flake update 
-nix flake archive --json \
-    | jq -r '.path,(.inputs|to_entries[].value.path)' \
-    | cachix push bonfire
-```
-
-* Build and push package:
-```sh 
-nix build --json .#package \
-    | jq -r '.[].outputs | to_entries[].value' \
-    | cachix push bonfire 
-```
-
-* Rebuild system with git submodules:
-```sh 
-nixos-rebuild switch --flake ".?submodules=1#astora"
-```
-
-* Rebuild remote system from local system with git submodules:
-```sh 
-nixos-rebuild switch --flake ".?submodules=1#catarina" --build-host l-nafaryus@astora --target-host l.nafaryus@catarina --use-remote-sudo
-```
+In any case, if you are already here, a great solution would be to first check the documentation for the project, where you can find useful information.
 
 # License
 
-
 **bonfire** is licensed under the [MIT License](LICENSE).
 
 > MIT license does not apply to the packages built by **Nix**, merely to the files

nixosConfigurations/catarina/default.nix

@@ -117,11 +117,10 @@ in {
                 globalRedirect = "elnafo.ru";
             };
 
-            "media.elnafo.ru" = {
+            "bonfire.elnafo.ru" = {
                 forceSSL = true;
                 useACMEHost = "elnafo.ru";
-                http2 = true;
-                locations."/".proxyPass = "http://127.0.0.1:8096";
+                locations."/".root = "${bonfire-pkgs.bonfire-docs}";
             };
         };
     };

packages/bonfire-docs/book.toml

@@ -11,6 +11,6 @@ default-theme = "macchiato"
 preferred-dark-theme = "macchiato"
 additional-css = ["./theme/catppuccin.css"]
 no-section-label = true
-git-repository-url = "https://github.com/L-Nafaryus/bonfire"
-git-repository-icon = "fa-github"
+git-repository-url = "https://vcs.elnafo.ru/L-Nafaryus/bonfire"
+git-repository-icon = "fa-git"
 cname = "elnafo.ru"

packages/bonfire-docs/default.nix

@@ -12,7 +12,7 @@ let
     links = [
         { 
             hostname = "vcs-elnafo"; 
-            url = "https://vcs.elnafo.ru/L-Nafaryus/bonfire/blob/master";
+            url = "https://vcs.elnafo.ru/L-Nafaryus/bonfire/src/branch/master";
         }
         {
             hostname = "github";
@@ -31,7 +31,7 @@ let
             # skip external declarations 
             lib.singleton declaration;
 
-    nixosModules = (import modulesPath { inherit lib; check = false; });
+    nixosModules = (import modulesPath { inherit lib; self = bonfire; check = false; });
 
     evaluatedModules = lib.evalModules {
         modules = nixosModules.modules ++ [ nixosModules.configModule ];

packages/bonfire-docs/src/SUMMARY.md

@@ -2,10 +2,6 @@
 
 [Introduction](README.md)
 
-- [Getting started](getting-started/README.md)
-  - [Stable Nix](getting-started/stable-nix.md)
-  - [Flakes](getting-started/flakes.md)
-
 - [Packages](packages/README.md)
   - [packages](packages/packages.md)
 
@@ -14,7 +10,5 @@
 
 - [FAQ](faq.md)
 
-- [Changelog](NEWS.md)
-
-- [Contributing](CONTRIBUTING.md)
+- [Contributing](contributing.md)
 

packages/bonfire-docs/src/contributing.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Just contribute and maybe there will be a contribution policy, maybe not. Nothing complicated, the same rules as everyone else, **just do it**.
+
+Bonfire's main source is [Elnafo VCS](https://vcs.elnafo.ru/L-Nafaryus/bonfire), but you can also create issues on [GitHub](https://github.com/L-Nafaryus/bonfire).

packages/bonfire-docs/src/faq.md

@@ -0,0 +1,32 @@
+# Frequently asked questions and hints
+
+* How to update and push flake inputs:
+
+```sh 
+nix flake update 
+nix flake archive --json \
+    | jq -r '.path,(.inputs|to_entries[].value.path)' \
+    | cachix push bonfire
+```
+
+* How to build and push flake package:
+
+```sh 
+nix build --json .#package \
+    | jq -r '.[].outputs | to_entries[].value' \
+    | cachix push bonfire 
+```
+
+* How to rebuild system with git submodules:
+
+```sh 
+sudo nixos-rebuild switch --flake ".?submodules=1#astora"
+```
+
+* How to rebuild remote system from local system with git submodules:
+
+```sh 
+nixos-rebuild switch --flake ".?submodules=1#catarina" --build-host l-nafaryus@astora --target-host l.nafaryus@catarina --use-remote-sudo
+```
+
+