danvics/selfhostblocks
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

docs: update links from pre-RFC to RFC

Browse source
This commit is contained in:
ibizaman 2025-08-26 22:40:02 +02:00 committed by Pierre Penninckx
parent 873847e903
commit a8eb543846
2 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -270,7 +270,7 @@ This lets you choose, for example,
any reverse proxy you want or any database you want,
without requiring work from maintainers of the services you want to self host.
A [pre-RFC][] exists to upstream this concept into `nixpkgs`.
An [RFC][] exists to upstream this concept into `nixpkgs`.
The [manual][contracts] also provides an explanation of the why and how of contracts.
Also, two videos exist of me presenting the topic,
@ -278,7 +278,7 @@ the first at [NixCon North America in spring of 2024][NixConNA2024]
and the second at [NixCon in Berlin in fall of 2024][NixConBerlin2024].
[contracts]: https://shb.skarabox.com/contracts.html
[pre-RFC]: https://discourse.nixos.org/t/pre-rfc-decouple-services-using-structured-typing/58257
[RFC]: https://github.com/NixOS/rfcs/pull/189
[NixConNA2024]: https://www.youtube.com/watch?v=lw7PgphB9qM
[NixConBerlin2024]: https://www.youtube.com/watch?v=CP0hR6w1csc
@ -286,7 +286,7 @@ and the second at [NixCon in Berlin in fall of 2024][NixConBerlin2024].
Thanks to [contracts](#contracts), one can interface NixOS
with systems on other OSes.
The [pre-RFC][] explains how that works.
The [RFC][] explains how that works.
### Sitting on the Shoulders of a Giant

7
docs/contracts.md
View file

@ -1,6 +1,13 @@
<!-- Read these docs at https://shb.skarabox.com -->
# Contracts {#contracts}
::: {.note}
An [RFC][] has been created which is the most up-to-date version of contracts.
The text here is still relevant although the implementation itself has changed a little bit.
[RFC]: https://github.com/NixOS/rfcs/pull/189
:::
A contract decouples modules that use a functionality from modules that provide it. A first
intuition for contracts is they are generally related to accessing a shared resource.