docs/site: revise content

This commit is contained in:
Gabriel Arazas 2023-07-09 14:07:59 +08:00
parent 3f2638be14
commit ccaec93a00
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
8 changed files with 46 additions and 10 deletions

View File

@ -3,16 +3,29 @@
Hey there!
This is my NixOS configuration abomination documentation "book" called "foodogsquared's NixOS config" book or "f(a)Nc(y)" config book for short.
.Here's a Nix snowflake logo for some reason
image::./nix-snowflake.svg[width=256px]
Why don't you start skimming the "book" by taking a glance at the table of contents over there.
[chat, Ezran]
[chat, Ezran, role=reversed]
====
And what if your readers doesn't find it?
====
[chat, foodogsquared]
====
I supposed you can view an entire page of it at link:./menu[`./menu`].
I suppose you can view an entire page of it at link:./menu[`./menu`].
====
[chat, Ezran, state=disappointed, role=reversed]
====
You didn't bother to improve the way how the menu rendered though unlike in mdBook or something similar.
====
[chat, foodogsquared]
====
Yeah, so?
It just happen to double as a neat standalone way to view the table of contents.
It's a feature, not a bug.
====

View File

@ -2,6 +2,7 @@
title: Frequently asked questions (FAQ)
---
= Frequently asked questions (FAQ)
:devos-example-commit: 580fc57ffaaf9cf3a582372235759dccfe44ac92
More like "Most anticipated questions (MAQ)" since almost no one asked me about this yet. :)
However, it doesn't roll off the tongue.
@ -19,7 +20,7 @@ Fortunately footnote:[Or unfortunately from a different perspective.], it is mos
For a more practical start, I recommend to look into several configurations to see the general gist of configuration with Nix.
Here's a few I personally dug into:
* {devos-link}
* github:divnix/digga[rev={devos-example-commit}, path=examples/devos]
* github:hlissner/dotfiles[]
* github:thiagokokada/nix-configs[]
--

View File

@ -20,25 +20,24 @@ Why would you have an entire book on just your NixOS configuration?
This seems like overkill.
====
[chat, foodogsquared]
[chat, foodogsquared, state=cheeky]
====
Because **it is overkill** and that's what we're going for.
====
[chat, Ezran, state=curious, role=reversed]
[chat, Ezran, state=disappointed, role=reversed]
====
And what is this book made of?
Hugo?
With Asciidoctor?
With a customized version of github:foo-dogsquared/hugo-theme-more-contentful[your own theme]?
Of all options!?!
Why?
Why not use something like github:rust-lang/mdBook[mdBook]?
Or link:https://squidfunk.github.io/mkdocs-material/[mkdocs-material] that makes things eas-
====
[chat, Ezran, role=reversed]
[chat, Ezran, state=skeptical, role=reversed]
====
You know what, I'm not going to continue with this.
I think I know why.

View File

@ -8,6 +8,13 @@ It's not guaranteed to be good as xref:../../using-parts-of-my-configuration/ind
Anyhow, there is a section for using my configuration with channels as shown in xref:../../using-parts-of-my-configuration/index.adoc#using-my-config-with-channels[Using my config with channels].
The entry point is found at github:{github-repo}[`./default.nix`, path=./default.nix, rev=master].
.`default.nix`
[source, nix]
----
include::../../../../../default.nix[]
----
However, you have to keep some limitations and guidelines in mind.
* It exports an attribute based from the github:nix-community/NUR/[NUR template].

View File

@ -36,3 +36,19 @@ Take note you cannot enable more than two workflows at any given time.
You can get around this by setting `workflows.disableLimit` to `true`.
However, this shouldn't be taken lightly as workflow modules are very vast in scope and are expected to set system settings that can affect your hardware, enabling (and/or disabling) system services, and modifying the list of installed applications (among other things).
[chat, foodogsquared]
====
By organizing the workflow modules this way, you can easily create your desktop rices without overlapping system settings.
Bless the Nix module system!
====
[chat, foodogsquared, state=cheeky]
====
Whether those rices are worth posting to Unix ricing communities is up to you though.
====
[chat, Ezran, state=disappointed, role=reversed]
====
Whippersnappers with your "riced"-up systems...
====

View File

@ -12,7 +12,7 @@ For reference, here's my current list of Firefox addons.
[source, json]
----
include::github:{github-repo}[path=pkgs/firefox-addons/firefox-addons.json]
include::../../../../../pkgs/firefox-addons/firefox-addons.json[]
----
But you're not done yet, you have to generate the output with the following command.

View File

@ -36,7 +36,7 @@ What about for secrets that have been separated into its own file, you ask.
The files under that namespace will be moved up in the filesystem which is not nice for organizing your decrypted secrets.
====
[chat, Ezran]
[chat, Ezran, role=reversed]
====
I'm going to guess you also have a function in your library for that.
====

View File

@ -119,7 +119,7 @@ You could also pin my config similarly to link:https://nix.dev/tutorials/towards
Here's a snippet of using it as part of a NixOS configuration.
[source, nix, subs=attributes]
[source, nix]
----
let
foo-dogsquared-nixos-config = import (fetchTarball "{canonical-flake-url-tarball-specific}") { inherit pkgs; };