Merge pull request 'docs: decisions harmonize with file tree' (#5367) from docs-simplify into main

Reviewed-on: https://git.clan.lol/clan/clan-core/pulls/5367
This commit is contained in:
hsjobeki
2025-10-03 15:08:28 +00:00
9 changed files with 17 additions and 27 deletions

View File

@@ -142,13 +142,13 @@ nav:
- HTTP API: api.md - HTTP API: api.md
- Decisions: - Decisions:
- Architecture Decisions: decisions/README.md - decisions/Architecture-decisions.md
- 01-clanModules: decisions/01-ClanModules.md - decisions/01-Clan-Modules.md
- 02-clan-api: decisions/02-clan-api.md - decisions/02-clan-as-library.md
- 03-adr-numbering-process: decisions/03-adr-numbering-process.md - decisions/03-adr-numbering-process.md
- 04-fetching-nix-from-python: decisions/04-fetching-nix-from-python.md - decisions/04-fetching-nix-from-python.md
- 05-deployment-parameters: decisions/05-deployment-parameters.md - decisions/05-deployment-parameters.md
- Template: decisions/_template.md - decisions/template.md
- Glossary: reference/glossary.md - Glossary: reference/glossary.md
- Services: - Services:
- Introduction to ClanServices: reference/clanServices/index.md - Introduction to ClanServices: reference/clanServices/index.md

View File

@@ -455,7 +455,7 @@ def produce_inventory_docs() -> None:
output = """# Inventory output = """# Inventory
This provides an overview of the available options of the `inventory` model. This provides an overview of the available options of the `inventory` model.
It can be set via the `inventory` attribute of the [`clan`](./clan.md#inventory) function, or via the [`clan.inventory`](./clan.md#inventory) attribute of flake-parts. It can be set via the `inventory` attribute of the [`clan`](/reference/options/clan_inventory.md) function, or via the [`clan.inventory`](/reference/options/clan_inventory.md) attribute of flake-parts.
""" """
# Inventory options are already included under the clan attribute # Inventory options are already included under the clan attribute

View File

@@ -1,5 +1,3 @@
# Clan service modules
## Status ## Status
Accepted Accepted

View File

@@ -1,5 +1,3 @@
# Clan as library
## Status ## Status
Accepted Accepted

View File

@@ -1,5 +1,3 @@
# ADR Numbering process
## Status ## Status
Proposed after some conversation between @lassulus, @Mic92, & @lopter. Proposed after some conversation between @lassulus, @Mic92, & @lopter.

View File

@@ -1,5 +1,3 @@
# deployment parameters: evalHost, buildHost, targetHost
## Status ## Status
accepted accepted

View File

@@ -1,5 +1,3 @@
# Architecture Decision Records
This section contains the architecture decisions that have been reviewed and generally agreed upon This section contains the architecture decisions that have been reviewed and generally agreed upon
## What is an ADR? ## What is an ADR?
@@ -11,6 +9,6 @@ This section contains the architecture decisions that have been reviewed and gen
## Crafting a new ADR ## Crafting a new ADR
1. Use the [template](./_template.md) 1. Use the [template](/decisions/template.md)
2. Create the Pull request and gather feedback 2. Create the Pull request and gather feedback
3. Retreive your adr-number (see: [numbering](./03-adr-numbering-process.md)) 3. Retreive your adr-number (see: [numbering](/decisions/03-adr-numbering-process.md))

View File

@@ -1,4 +1,4 @@
# Decision record template by Michael Nygard ## Decision record template by Michael Nygard
This is the template in [Documenting architecture decisions - Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). This is the template in [Documenting architecture decisions - Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
You can use [adr-tools](https://github.com/npryce/adr-tools) for managing the ADR files. You can use [adr-tools](https://github.com/npryce/adr-tools) for managing the ADR files.

View File

@@ -3,9 +3,9 @@
## Service Module Specification ## Service Module Specification
This section explains how to author a clan service module. This section explains how to author a clan service module.
We discussed the initial architecture in [01-clan-service-modules](../../decisions/01-ClanModules.md) and decided to rework the format. We discussed the initial architecture in [01-clan-service-modules](/decisions/01-Clan-Modules.md) and decided to rework the format.
For the full specification and current state see: **[Service Author Reference](../../reference/clanServices/clan-service-author-interface.md)** For the full specification and current state see: **[Service Author Reference](/reference/clanServices/clan-service-author-interface.md)**
### A Minimal module ### A Minimal module
@@ -47,7 +47,7 @@ The imported module file must fulfill at least the following requirements:
} }
``` ```
For more attributes see: **[Service Author Reference](../../reference/clanServices/clan-service-author-interface.md)** For more attributes see: **[Service Author Reference](/reference/clanServices/clan-service-author-interface.md)**
### Adding functionality to the module ### Adding functionality to the module
@@ -300,6 +300,6 @@ instnaces.machine-type = {
## Further Reading ## Further Reading
- [Reference Documentation for Service Authors](../../reference/clanServices/clan-service-author-interface.md) - [Reference Documentation for Service Authors](/reference/clanServices/clan-service-author-interface.md)
- [Migration Guide from ClanModules to ClanServices](../migrations/migrate-inventory-services.md) - [Migration Guide from ClanModules to ClanServices](/guides/migrations/migrate-inventory-services.md)
- [Decision that lead to ClanServices](../../decisions/01-ClanModules.md) - [Decision that lead to ClanServices](/decisions/01-Clan-Modules.md)