hsjobeki
9300fd9dc7
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
dd1429c89f
Docs: fix rendering clan source code url
2025-07-09 17:24:20 +02:00
Jörg Thalheim
8d4099d13d
refactor: move docs transformOptions to clanLib to reduce rebuilds
...
- Add clanLib.docs.stripStorePathsFromDeclarations to deduplicate code
- Update all documentation generation to use the shared function
- This strips store paths from option declarations to prevent options.json
from rebuilding when only store paths change but content remains the same
- Reduces unnecessary documentation rebuilds when making unrelated changes
2025-07-09 16:59:58 +02:00
Johannes Kirschbauer
14a221d1d1
Docs: remove 'replaces' sentence; it is not describing any purpose
2025-07-08 10:01:51 +02:00
Jörg Thalheim
6a6688019b
docs: no longer depend on self
2025-07-07 20:24:11 +02:00
Jörg Thalheim
9c37ef4cbe
add dev flake pattern
...
This allows us to have dev dependencies which are not propagated to the user.
2025-07-07 15:59:09 +00:00
Johannes Kirschbauer
62c1db9769
Docs: init redoc internal rest inspired docs
2025-07-04 12:45:39 +02:00
Johannes Kirschbauer
d011b1ab02
docs: rename all references from 'buildClan' to 'lib.clan'
2025-06-27 09:54:23 +02:00
Johannes Kirschbauer
11a94893fb
refactor: unify evalClanService with evalService
2025-06-26 14:50:35 +02:00
Johannes Kirschbauer
c91b5fb3db
build-inventory: move inventory and inventoryClass into explizitly different folders
2025-06-25 17:55:45 +02:00
Johannes Kirschbauer
16392622c5
Chore: add _file for internals error tracing
2025-06-25 15:47:18 +02:00
Johannes Kirschbauer
1819243123
inventory/interface: reduce apply arguments chain by adding it to _module.args
2025-06-25 15:15:22 +02:00
DavHau
2b73671f18
docs/devshell: unbreak - add options-page
...
Create the options-page subpage when the docs dev shell is loaded.
Also simplify the dev shell definition by just utilizing what's in configurePhase of the docs derivation
2025-06-25 13:48:50 +07:00
DavHau
4421ce006e
docs: add clan options search page
...
This provides a simpler and more intuitive search over a flat list of possible options.
Styling still to be improved
2025-06-25 12:55:25 +07:00
Johannes Kirschbauer
f6c5113394
docs: expose clan service authoring interface
2025-06-04 12:43:03 +02:00
Johannes Kirschbauer
a192ab4910
Fix(docs): dont link to assumed successor
2025-06-03 18:35:00 +02:00
pinpox
13a9b17198
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
5bc6126873
docs: misc clean up
2025-05-22 00:01:01 +10:00
Johannes Kirschbauer
3285efa55d
docs: exclude options that are not modules from clan.core submodule index
2025-05-21 09:11:18 +02:00
Johannes Kirschbauer
188e6d5d16
Docs: add links to submodules
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
a9ed972834
docs: fix clan-core should be called clan.core
...
Consistent with the module name
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
c34b693a64
docs: consistent clan-core overview
2025-05-20 18:49:35 +02:00
Johannes Kirschbauer
88f7b3410e
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
df5010084f
Docs: create migrations subfolder in guides
2025-05-18 18:46:36 +02:00
Johannes Kirschbauer
f210b2f9a6
refactor: move clan_cli.error to clan_lib.error
2025-05-16 16:14:39 +02:00
hsjobeki
56f3fd0a45
Merge pull request 'Docs for clan service options' ( #3670 ) from service-docs into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/3670
2025-05-16 13:02:28 +00:00
Johannes Kirschbauer
21f87f169a
Docs: improve clanService docs
2025-05-16 14:58:46 +02:00
pinpox
8220c32142
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
Jörg Thalheim
cc20e0bf35
clan-ui: remove intermediate app directory
2025-05-15 14:56:04 +02:00
Jörg Thalheim
2561e3e4d1
rename ui to clan-app and move clan-app one layer up
2025-05-15 14:15:59 +02:00
Brian McGee
c26cc9503c
feat: group ui related packages under a ui directory
2025-05-15 12:00:24 +01:00
Jörg Thalheim
028a401931
docs/devshell: make sure we are in the right directory before symlinking files
2025-05-13 12:24:20 +02:00
Jonathan Thiessen
839f8fb347
Avoid a few cases of chmod-after-creation
2025-04-28 17:11:21 -07:00
Johannes Kirschbauer
acbe619883
Refactor(clan_lib): move clan_cli.api into clan_lib.api
2025-04-26 19:51:35 +02:00
Johannes Kirschbauer
a6a79e83a0
treewide(clanLib): rename all occurences of {clan-core,self}.lib to 'clanLib'
2025-04-09 11:32:46 +02:00
Sam Lehman
e0a6ed3d49
devshells: name shells for clarity
2025-04-08 19:31:30 +00:00
Johannes Kirschbauer
ce84c4cddb
chore(lib/modulesDocs): move dependency on clan-core and pkgs into function args
...
This is a good idea, to make lib agnostic from clan-core
The next step could be to rename the clan-core argument name
Or to explizitly pass the actual dependencies, instead of everything in
clan-core
2025-04-08 15:30:49 +02:00
Johannes Kirschbauer
c25574bebd
fix(lib/evalClan): evalClan is an explizit lib attribute
2025-03-30 17:07:11 +02:00
Jörg Thalheim
873f650678
remove directory = self from our documentation
2025-02-15 01:48:17 +00:00
DavHau
3ec028d672
tests: reduce unnecessary rebuilds of several tests
...
Some test were referring to the whole source code via ${self} which amde them rebuild on every single commit.
This is not mitigated by introduceing `self.filter { include = [...]; }` allowin to a content addressed subset of the source code in tests.
2025-01-17 17:00:18 +07:00
Jörg Thalheim
e2aa66d86f
reformat after update
2025-01-14 15:30:29 +01:00
Johannes Kirschbauer
01adae4f3d
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
DavHau
00064ee98b
wifi: init as experimental module
2024-11-28 15:49:23 +07:00
Johannes Kirschbauer
200cffe4ee
Docs/modules: add missing heading for empty role options
2024-11-20 12:25:04 +01:00
Johannes Kirschbauer
25e2307ecc
Docs/modules: add usage example
2024-11-20 11:42:02 +01:00
Johannes Kirschbauer
6e61db7f83
Docs/modules: seperate out inventory,role specific interface
2024-11-20 11:01:28 +01:00
Johannes Kirschbauer
8544387d65
Docs/frontmatter: init automatic reference for frontmatter
2024-11-19 10:35:13 +01:00
Qubasa
09e0d8add3
docs: Remove old blog, remove empty concepts rider
2024-11-18 17:25:47 +01:00
Johannes Kirschbauer
417db1e1e8
Docs: fix missing icons & favicon
2024-11-06 13:56:20 +01:00
Jörg Thalheim
4cc9fcfc77
deploy-docs: use checksum for rsync
2024-10-22 17:41:54 +02:00
