From 25c595539c525a74c7a39d58db3fbeb061c02d5f Mon Sep 17 00:00:00 2001 From: clsource Date: Sun, 9 Mar 2025 10:18:13 -0300 Subject: [PATCH] improved docs --- docs/modules/decisions/pages/use-bruno.adoc | 1 + docs/modules/developer/nav.adoc | 1 + docs/modules/developer/pages/dev_environment.adoc | 9 ++++++++- docs/modules/developer/pages/jj.adoc | 4 ++++ 4 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 docs/modules/developer/pages/jj.adoc diff --git a/docs/modules/decisions/pages/use-bruno.adoc b/docs/modules/decisions/pages/use-bruno.adoc index e7716ed5..5fb7daba 100644 --- a/docs/modules/decisions/pages/use-bruno.adoc +++ b/docs/modules/decisions/pages/use-bruno.adoc @@ -20,6 +20,7 @@ Chosen option: "`Bruno`", because - Open-source - Supports both GraphQL and REST. - Uses local files for storing API collections, enabling integration with Git. + == Consequences - The project will use Bruno to maintain API request collections directly within the repository. diff --git a/docs/modules/developer/nav.adoc b/docs/modules/developer/nav.adoc index a6afa9cb..21ad7c9b 100644 --- a/docs/modules/developer/nav.adoc +++ b/docs/modules/developer/nav.adoc @@ -1,4 +1,5 @@ .Developer Docs * xref:dev_environment.adoc[] +* xref:jj.adoc[] * xref:extensions.adoc[] * xref:test_plan.adoc[] diff --git a/docs/modules/developer/pages/dev_environment.adoc b/docs/modules/developer/pages/dev_environment.adoc index 790180f2..2c0bf47a 100644 --- a/docs/modules/developer/pages/dev_environment.adoc +++ b/docs/modules/developer/pages/dev_environment.adoc @@ -58,16 +58,23 @@ $ sudo vim /etc/nix/nix.conf [source, text] ---- -trusted-users = root camilowser +trusted-users = root ---- - 3. Reboot nix service +.MacOS [source, bash] ---- sudo launchctl kickstart -k system/org.nixos.nix-daemon ---- +.Linux +[source, bash] +---- +sudo systemctl restart nix-daemon.service +---- + == Direnv Install https://direnv.net/docs/installation.html#from-system-packages[Direnv] to automatically load _Devenv_ on entering the directory and load other system settings. diff --git a/docs/modules/developer/pages/jj.adoc b/docs/modules/developer/pages/jj.adoc new file mode 100644 index 00000000..ac775d48 --- /dev/null +++ b/docs/modules/developer/pages/jj.adoc @@ -0,0 +1,4 @@ += Using Jujutsu + +We recommend using https://github.com/jj-vcs/jj[_Jujutsu_] tool for working with Git repositories. Is totally optional +but can make developer life easier by managing branches and merge flows. \ No newline at end of file