Improve documentation

#295 #294 #293
SMPTE · Dec 22, 2024 · 193dd3f · 193dd3f
1 parent 4d35e65
commit 193dd3f
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/doc/main.html b/doc/main.html
@@ -62,7 +62,13 @@ <h2>Quick start</h2>
         <a>https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks</a>.
       </li>
       <li>
-        Start editing the main prose element at <code>html-pub-template/doc/main.html</code>.
+        If working on a project that has a repository, update the <code>origin</code> remote to that repository:
+<pre>git remote set-url origin &lt;HTTPS URL of the project repository found on GitHub&gt;</pre>
+        For example:
+<pre>git remote set-url origin https://github.com/SMPTE/stxxx-y-private.git</pre>
+      </li>
+      <li>
+        Start editing the main prose element at <code>doc/main.html</code>.
       </li>
     </ol>
 
@@ -2148,7 +2154,9 @@ <h3>Sample Workflow </h3>
           <ol type="a">
             <li>Follow the steps in <a href="#sec-quick-start"></a> to create repo.</li>
             <li>A new branch is created from <code>main</code> called <code>2023-initial-draft</code> (where "2023" is the current year).</li>
-            <li>Template document is updated in <code>2023-initial-draft</code> branch to <code>&lt;meta itemprop="pubState" content="draft" /&gt;</code> and to <code>&lt;meta itemprop="pubStage" content="WD" /&gt;</code>.</li>
+            <li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
+            href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
+            <code>draft</code> and <code>WD</code>, respectively.</li>
             <li>Document editor creates initial version of the document.</li>
             <li>A PR is created named <code>2023 Initial Draft</code> from the <code>2023-initial-draft</code> branch on GitHub. </li>
             <li>Skip to Workflow Step (4)</li>
@@ -2159,8 +2167,11 @@ <h3>Sample Workflow </h3>
           <ol type="a">
             <li>Assumption: There is a prior release labeled <code>2020115-pub</code></li>
             <li>A new branch is created from <code>main</code> called <code>2023-revision</code> (where "2023" is the current year).</li>
-            <li>Document is updated in <code>2023-revision</code> branch to <code>&lt;meta itemprop="pubState" content="draft" /&gt;</code> and to <code>&lt;meta itemprop="pubStage" content="WD" /&gt;</code>.</li>
-            <li><code>.smpte-build.json</code> is updated in <code>2023-revision</code> branch to last release tag <code>2020115-pub</code> (see <a href="#sec-document-github-releases"></a>) </li>
+            <li>Make sure that the <code>pubState</code> (<a href="#sec-pubState"></a>) and <code>pubStage</code> (<a
+              href="#sec-pubStage"></a>) of the main prose element in the <code>2023-initial-draft</code> branch are set to
+              <code>draft</code> and <code>WD</code>, respectively.</li>
+            <li><code>.smpte-build.json</code> is updated in <code>2023-revision</code> branch to last release tag
+            <code>2020115-pub</code> (see <a href="#sec-document-github-releases"></a>) </li>
             <li>Document editor makes initial changes to the document.</li>
             <li>A PR is created named <code>2023 Revision</code> from the <code>2023-revision</code> branch on GitHub. The tooling with create a redline against the most recent edition of the document.</li>
             <li>Continue to Workflow Step (4)</li>