Johannes Kirschbauer
3068a9e16a
docs: move service definition into explizit markdown file
2025-10-03 21:16:32 +02:00
Johannes Kirschbauer
8d9d4c9089
docs: fix absolute links need to be absolute
2025-10-03 18:59:47 +02:00
Johannes Kirschbauer
76d1d9b167
docs: consistent options reference
2025-10-03 18:17:13 +02:00
Johannes Kirschbauer
028cf2a00c
docs: move official services into subfolder
2025-10-03 17:56:47 +02:00
Johannes Kirschbauer
08c2d574ce
docs: use absolute page URI
...
This allows us to migrate to any framework that uses normal uri's
We just need to strip all .md endings in a simple grep command
2025-10-03 17:31:42 +02:00
Johannes Kirschbauer
f9c8ed74e1
docs: decisions harmonize with file tree
2025-10-03 17:06:14 +02:00
Johannes Kirschbauer
90b1033870
docs: unify markdown files with documentation titles
...
This is preparational work to reduce the surface are of the different mappings
We want to reduce the following:
/guides/secrets.md -> Guides/getting started/How to use flakes with sops -> with '# Secrets Management'
- Title
- URI
- Filepath
should follow a stricter pattern to make it easy to maintain
2025-10-03 16:08:20 +02:00
Johannes Kirschbauer
757f2412a6
docs: bring back structured clan options
2025-09-17 15:15:32 +02:00
Luis Hebendanz
d4e601586d
Merge pull request 'docs: init new structure' ( #5157 ) from improve_vars_docs2 into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/5157
2025-09-16 14:48:15 +00:00
Johannes Kirschbauer
b1e3e3616e
docs: remove unused export
2025-09-16 16:02:10 +02:00
Qubasa
3f5bf8e171
docs: remove stale link
...
docs: revert nuschtos changes
2025-09-16 16:01:03 +02:00
Jörg Thalheim
d5b09f18ed
RET504: fix
2025-08-26 15:55:23 +02:00
Jörg Thalheim
fb2fe36c87
SIM112: fix
2025-08-26 15:55:23 +02:00
Jörg Thalheim
1d0e0f243e
PLW2901: fix
2025-08-25 15:17:06 +02:00
Jörg Thalheim
76eb3c13e9
add various module docstrings
2025-08-25 13:06:04 +02:00
Jörg Thalheim
0ec2c32ff8
ruff: apply automatic unsafe fixes
2025-08-25 11:34:41 +02:00
Jörg Thalheim
ea2d6aab65
ruff: apply automatic fixes
2025-08-25 11:34:41 +02:00
Johannes Kirschbauer
1f2f71ab03
lib/modules: make categories class method
2025-08-21 14:41:03 +02:00
Johannes Kirschbauer
a83f301e59
docs/render: remove dead code
2025-08-20 20:19:49 +02:00
Johannes Kirschbauer
cbbc235570
api/modules: rename Frontmatter -> ModulesFrontmatter to make room for other disk templates metadata
2025-08-20 19:46:28 +02:00
Johannes Kirschbauer
72e7c2e9b9
clanModules: cleanup some more unused code
2025-08-16 12:56:30 +02:00
Johannes Kirschbauer
308a10d6e6
clanModules: remove unused code
2025-08-16 11:48:13 +02:00
pinpox
35e5f4a42a
Remove clanModules
...
- Removes clanModules in favor of the new clanServices
- Adds a warning and link to the migration guide
2025-08-14 12:02:40 +02:00
Johannes Kirschbauer
caaf9dc4f3
docs: unify documentation
...
Strictly enforce diataxis
Use resource driven approach
Can extend later to add 'developer' link index page
2025-07-24 16:51:57 +02:00
Qubasa
5c7e6b3830
docs: Move developer guides into the Developer section
...
nix fmt
address davhau review
2025-07-23 18:31:19 +07:00
lassulus
60768cc537
Add networking module
...
This adds a (for now hidden) clan network command that exposes list,
ping, overview subcommands to get informations about configured
networks.
ClanServices can now use the exports to define network specific
information.
This is not the complete feature yet, as we are lacking more tests and
documentation, but merging this now makes it easier to iterate.
2025-07-17 15:23:08 +02:00
hsjobeki
341f444fa0
revert bd3861c580
...
revert Merge pull request 'Remove clanModules/*' (#4202 ) from remove-modules into main
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4202
See: https://git.clan.lol/clan/clan-core/issues/4365
Not all modules are migrated.
If they are not migrated, we need to write migration docs and please display the link to the migration docs
2025-07-15 17:51:36 +00:00
pinpox
0e53499f40
Remove clanModules
2025-07-15 11:53:32 +02:00
Johannes Kirschbauer
943dde4bbf
lib/modules: move from api to services module
2025-07-13 13:57:02 +02:00
hsjobeki
f9de0206eb
Merge pull request 'refactor: move docs transformOptions to clanLib to reduce rebuilds' ( #4259 ) from self into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4259
2025-07-09 15:31:25 +00:00
Johannes Kirschbauer
5c234ac643
Docs: fix rendering clan source code url
2025-07-09 17:24:20 +02:00
Johannes Kirschbauer
dfb3a45fa5
Docs: remove 'replaces' sentence; it is not describing any purpose
2025-07-08 10:01:51 +02:00
Johannes Kirschbauer
731de62876
docs: rename all references from 'buildClan' to 'lib.clan'
2025-06-27 09:54:23 +02:00
Johannes Kirschbauer
6e7b2f94e5
docs: expose clan service authoring interface
2025-06-04 12:43:03 +02:00
Johannes Kirschbauer
58a75e7f17
Fix(docs): dont link to assumed successor
2025-06-03 18:35:00 +02:00
pinpox
64c339dafe
modules/borgbackup: migrate to clanServices
...
Migrates the borgbackup module to clanServices, preserving it's original
configuration syntax and functionality
2025-06-02 16:12:37 +02:00
Michael Hoang
508bb14809
docs: misc clean up
2025-05-22 00:01:01 +10:00
Johannes Kirschbauer
2ba110d354
docs: exclude options that are not modules from clan.core submodule index
2025-05-21 09:11:18 +02:00
Johannes Kirschbauer
464e3c33cf
Docs: add links to submodules
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
8ad35c1bee
docs: fix clan-core should be called clan.core
...
Consistent with the module name
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
3c56ae1755
docs: consistent clan-core overview
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
af58c32238
Docs: unify 'manual' with 'guides' folder
...
This is one of the final steps towards strictly following
https://diataxis.fr/
2025-05-18 20:40:40 +02:00
Johannes Kirschbauer
f387ab0882
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
fe0507b47c
refactor: move clan_cli.error to clan_lib.error
2025-05-16 16:14:39 +02:00
Johannes Kirschbauer
62d2c08dd5
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
da3c1ceea3
Add clanServices to docs
...
Renders the documentation for clanServices. Options for the modules are
extracted and rendered the same way as for the existing clanModules.
Additionally tweaks the typography for the documentation of options
slightly
2025-05-16 11:29:50 +02:00
Johannes Kirschbauer
f6628ec1a9
Refactor(clan_lib): move clan_cli.api into clan_lib.api
2025-04-26 19:51:35 +02:00
Jörg Thalheim
5d42aa2f42
remove directory = self from our documentation
2025-02-15 01:48:17 +00:00
Jörg Thalheim
3bcbc8fa3d
reformat after update
2025-01-14 15:30:29 +01:00
Johannes Kirschbauer
d7c0ad40a2
Docs: refactor all option documentation to use tree representations
...
Using a tree instead of a list leads to better representation of options
In the future this could also enable better disvocerability by applying tree-specific filters and views
The OptionList should only be used as an exchange format between nix and rendering tools
2024-12-31 13:34:32 +01:00
