Improve documentation (#127)

* Docs: Improve readability of inputs docs

* Docs: Clarify SSH key usage

.config/autodoc.js → .config/autodoc.mjs

@@ -1,6 +1,6 @@
-const YAML = require("yaml");
-const tablemark = require("tablemark");
-const fs = require("fs");
+import fs from "fs";
+import tablemark from "tablemark";
+import YAML from "yaml";
 
 const file = fs.readFileSync("./action.yml", "utf8");
 
@@ -11,7 +11,7 @@ Object.keys(yml.inputs).forEach((input) => {
   table.push({
     input,
     required: yml.inputs[input] && yml.inputs[input].required ? "yes" : "",
-    default: yml.inputs[input] && yml.inputs[input].default ? yml.inputs[input].default : "",
+    default: yml.inputs[input] && yml.inputs[input].default ? "`" + yml.inputs[input].default + "`" : "",
     description: yml.inputs[input] && yml.inputs[input].description ? yml.inputs[input].description : "",
   });
 });

.config/commit-docs.sh

@@ -1,3 +1,4 @@
+# Copied from commit-build.sh
 # This script is used for repos that need to commit a build folder (eg. Github actions)
 
 # Add more sources/destinations by separating them by spaces (ie. source="src lib")
@@ -11,7 +12,7 @@ then
 
   # Run build command
   echo "Generating $build..."
-  node .config/autodoc.js
+  node .config/autodoc.mjs
 
   # If this generated unstaged changes in $build folder(s)
   if [[ $(git status --porcelain $build | egrep '^(([M ]M)|\?\?)') ]]

action.yml

@@ -70,7 +70,7 @@ inputs:
     default: ""
 
   committer:
-    description: "Who will commit changes."
+    description: "Who will commit changes (author will be original committer)."
     required: false
     default: Github Actions <[email protected]>
 

docs/basic-usage.md

@@ -8,7 +8,8 @@ Once they are merged on SoT, Copybara will automatically push the code to the de
 
 - **Source of Truth (SoT) repo**
 - **Destination repo**
-- **[SSH private key](ssh-keys.md)** with write access to destination repo (used to push code)
+- **[SSH private key](ssh-keys.md)** with write access to both repos (used to
+  push code on destination and create/commit to branches on SoT)
 - **[GitHub Personal access token](https://github.com/settings/tokens)** with 'repo' permissions (used for determining default branches and managing pull requests on both repos)
 
 ## Examples