docs: add reference index pages #1743
No reviewers
Labels
No Label
backups
blog
bootstrapping
bug
changes-requested
cli
documentation
duplicate
enhancement
facts
help wanted
invalid
Inventory
low_prio
manager
modules
needs-review
networking
packaging
question
secrets
template
test
tooling
user-testing
vm
wontfix
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: clan/clan-core#1743
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "fricklerhandwerk/clan-core:rearrange-docs-front"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
@ -0,0 +1,57 @@
# Inventory
this file can be generated from suorce, could we remove it first ?
nix build git+https://git.clan.lol/clan/clan-core#inventory-schema-pretty
@ -50,11 +50,10 @@ nav:
- Mesh VPN: getting-started/mesh-vpn.md
- Backup & Restore: getting-started/backups.md
- Flake-parts: getting-started/flake-parts.md
- Concepts:
I added further explanation to the inventory there.
Maybe the wording is not perfect yet. But i think we need some section where we explain how to use things,
in addition to un-opinionated api docs, that are mostly gernerated from interface declarations.
inventory-tutorial (handwritten) and inventory API (generated) are distinct sites for us.
The same applied to most sites:
one page api docs, auto generated
one page tutorial, for opinionated usage, manually maintained.
Merged this commit, with my proposed changes added in #1781
Pull request closed