docs: improve settings a bit

boris-smidt-klarrio · Dec 15, 2024 · d53d011 · d53d011
1 parent 53ddc76
commit d53d011
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/docs/environments/secrets.md b/docs/environments/secrets.md
@@ -74,4 +74,4 @@ export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 <script setup>
 import Settings from '/components/settings.vue';
 </script>
-<Settings child="sops" :level="3" />
+<Settings child="sops" :level="4" />
diff --git a/docs/settings.data.ts b/docs/settings.data.ts
@@ -14,7 +14,7 @@ export default {
     function buildElement(key, props) {
       let type = props.type;
       type = type.replaceAll("PathBuf", "String");
-      let default_ = props.default;
+      let default_ = props.default_docs ?? props.default;
       if (default_ === undefined && type === "Bool" && !props.optional) {
         default_ = false;
       }
@@ -42,7 +42,7 @@ export default {
         deprecated: props.deprecated,
         enum: props.enum,
         env: props.env,
-        optional: props.optional,
+        optional: !props.default_docs && props.optional,
         type,
       };
       return ele;

diff --git a/settings.toml b/settings.toml
@@ -650,6 +650,8 @@ optional = true
 default_docs = "install_only_stripped"
 description = "Specify the flavor to use for precompiled binaries."
 docs = """
+Specify the flavor to use for precompiled binaries.
+
 Options are available here: <https://gregoryszorc.com/docs/python-build-standalone/main/running.html>
 """