Michael Hoang
dc03a9183f
docs: macOS
2025-08-01 15:45:41 +10:00
Kenji Berthold
bac2f15668
Merge pull request 'docs: Fix typos in hero section of the documentation index' ( #4495 ) from kenji/ke-docs-fix-typo into main
...
Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/4495
2025-07-25 12:45:19 +00:00
a-kenji
9ebba12e5b
docs: Fix typos in hero section of the documentation index
2025-07-25 14:30:32 +02:00
a-kenji
1924d222e1
docs: Fix grammar of getting started card
2025-07-25 14:29:19 +02:00
Qubasa
986e74663a
docs: Replace backup guide with the new one from Bruno Adele
...
docs: fix build errors
2025-07-25 17:30:05 +07:00
Qubasa
cad7d2d95f
docs: reword concepts description
...
docs: fix build errors
2025-07-25 16:29:22 +07:00
Qubasa
e1f57cd618
docs: Improve the documentation index page
2025-07-25 16:07:18 +07:00
Johannes Kirschbauer
b6a04e4f12
docs: restore index page
2025-07-24 16:54:49 +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
pinpox
50803c2e25
Add general intro doc text
2025-07-23 18:32:28 +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
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
Michael Hoang
508bb14809
docs: misc clean up
2025-05-22 00:01:01 +10: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
Jörg Thalheim
575f5b6626
add documentation on how to use macOS
2025-05-20 12:56:02 +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
b35c1c2e46
Docs: place reference to new ClanModules on index page
2025-05-18 18:40:10 +02:00
Johannes Kirschbauer
1806c6c16e
Docs: move 'getting-started' into guides section
2025-05-18 18:35:11 +02:00
Johannes Kirschbauer
7ff62958e6
Docs: move {contributing, disk, mesh, backups} into guides
2025-05-18 18:22:32 +02:00
Johannes Kirschbauer
64bef5980f
docs: move authoring guides into guides subfolder
2025-05-16 16:33:39 +02:00
a-kenji
fb29d38883
docs/index: Surface reference documentation
2025-05-13 10:51:22 +00:00
Johannes Kirschbauer
485b6ae5c4
docs(authoring): restructure authoring guides
...
Mainly because we have two module specs now and they will remain
valid for a while. We need to keep the older format documented for a while
2025-04-08 21:32:19 +02:00
a-kenji
d7d8d55c45
docs/index: Clear up API Reference description
...
The term "auto generated" gives leeway to the incorrect assumption
that this is not a curated reference that contains written documentation
especially for the rendered reference.
This is not the case.
2025-03-22 12:56:51 -07:00
DavHau
188c5dfb17
docs: move contributing+debugging to section contributing
2025-03-11 15:19:46 +07:00
a-kenji
d34f976057
docs/site: Fix flake-parts link
2025-03-03 03:53:49 +00:00
Qubasa
030b046552
Reapply "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit ba517f56b3
2025-01-18 10:00:56 +07:00
Jörg Thalheim
ba517f56b3
Revert "docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view."
...
This reverts commit 257e1893ee
2025-01-17 15:44:44 +01:00
Qubasa
257e1893ee
docs: Document imports dir. Remove What's next sections everywhere. Merge guide overview and hompage view.
2025-01-17 21:03:25 +07:00
Qubasa
9aa4a81a91
docs: Remove old blog, remove empty concepts rider
2024-11-18 17:25:47 +01:00
Johannes Kirschbauer
e0af6d22cb
Docs: fix typo
2024-10-16 14:54:29 +02:00
Johannes Kirschbauer
026481f9d7
Docs: harmonize titles
2024-09-25 14:06:55 +02:00
Johannes Kirschbauer
60ddd3369e
Docs: restructure apply diataxis
2024-09-25 13:37:35 +02:00
Johannes Kirschbauer
55526b1fdb
Docs: add top-level index, refactor according to diataxis
2024-09-22 18:39:13 +02:00
Jörg Thalheim
fabfba77cf
rework installation template based on received feedback
2024-07-22 16:08:59 +02:00
Jörg Thalheim
b5f6200148
docs/setup: recommends nixos configuration for nixos users
2024-07-22 05:59:03 +02:00
Jörg Thalheim
d0f01f3c17
docs/setup: also mention experimental option in case someone already has nix installed
2024-07-22 05:59:02 +02:00
Qubasa
69d1c792b0
Add bcachefs support. Fix clan flash docu.
2024-05-18 23:18:02 +02:00
Qubasa
f0bc96072d
Change favicon. Add socials. Add RSS link.
2024-05-17 16:07:14 +02:00
Qubasa
37c72b8848
Reorder getting started documentation
2024-05-10 22:59:45 +02:00
a-kenji
4bc30e575a
docs: add reference to the help page
2024-05-07 20:45:09 +02:00
clan-bot
fe70fd4bfb
Merge pull request 'docs: improve getting started prerequisite docs' ( #1322 ) from a-kenji-docs-patch-2 into main
2024-05-07 13:48:22 +00:00
a-kenji
37430ecd13
docs: improve getting started prerequisite docs
2024-05-07 15:45:38 +02:00
a-kenji
de8f73890a
docs: add link to cli reference
2024-05-07 15:34:56 +02:00
a-kenji
403ff66eb4
add: cd command
2024-04-23 20:52:41 +02:00
clan-bot
646bf069d2
Merge pull request 'documentation: fix typo' ( #1207 ) from a-kenji-fix/typ into main
2024-04-14 09:56:20 +00:00
a-kenji
dc771ea299
documentation: fix typo
2024-04-14 11:46:53 +02:00
a-kenji
755a22553f
documentation: disable copy for outputs
2024-04-14 11:45:20 +02:00
Johannes Kirschbauer
c77c1b05d2
docs: decompose configuration guide
2024-04-13 15:46:38 +00:00
a-kenji
dd3cee4992
documentation: standardize on bash doccomments
2024-04-13 16:35:16 +02:00
