Skip to content

Commit 10a7d12

Browse files
authored
fix(#185): align website guides with selected doc surface (#190)
Update the GitHub Pages guide pages so CLI and PowerShell surfaces stay separated consistently, remove end-user Invoke-NovaCli guidance, and clarify when Install-NovaCli is required.
1 parent 970cc9a commit 10a7d12

6 files changed

Lines changed: 59 additions & 32 deletions

File tree

docs/assets/icon.png

-1.75 MB
Loading

docs/core-workflows.html

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -261,19 +261,29 @@ <h2>Reload safely after changes</h2>
261261
inside a long-lived interactive PowerShell session, switch to the PowerShell view and do the
262262
full remove/build/import loop.</p>
263263
</div>
264-
<div class="notice">
264+
<div class="notice" data-command-visibility="powershell">
265265
<strong>When local publish changes the story.</strong>
266-
<p><code>PS&gt; Publish-NovaModule -Local</code> and <code>% nova publish --local</code> reload the
267-
published
268-
module from the local install path after a successful publish. That is different from the normal
269-
build/import loop, which works from <code>dist/</code>.</p>
266+
<p><code>Publish-NovaModule -Local</code> reloads the published module from the local install path
267+
after a successful publish. That is different from the normal build/import loop, which works
268+
from <code>dist/</code>.</p>
270269
</div>
271-
<div class="notice">
270+
<div class="notice" data-command-visibility="command-line" hidden>
271+
<strong>When local publish changes the story.</strong>
272+
<p><code>% nova publish --local</code> moves the module into the local install path so a fresh
273+
PowerShell session can resolve the published copy directly. That is different from the normal
274+
build/import loop, which still validates <code>dist/</code>.</p>
275+
</div>
276+
<div class="notice" data-command-visibility="powershell">
272277
<strong>CI/self-hosting note.</strong>
273278
<p>When a later command in the same session must switch back to the built <code>dist/</code> module,
274-
use <code>Invoke-NovaBuild -ContinuousIntegration</code> or <code>% nova build
275-
--continuous-integration</code>
276-
so Nova restores the built module state automatically.</p>
279+
use <code>Invoke-NovaBuild -ContinuousIntegration</code> so Nova restores the built module state
280+
automatically.</p>
281+
</div>
282+
<div class="notice" data-command-visibility="command-line" hidden>
283+
<strong>CI/self-hosting note.</strong>
284+
<p>When a later command in the same self-hosting session must switch back to the built
285+
<code>dist/</code> module, use <code>% nova build --continuous-integration</code> so Nova
286+
restores the built module state automatically.</p>
277287
</div>
278288
</section>
279289

docs/getting-started.html

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -123,10 +123,15 @@ <h2>2. Install the module</h2>
123123
you
124124
plan to use the standalone command-line launcher later.</p>
125125
</div>
126-
<p>After import, you can use the PowerShell cmdlets directly. If you explicitly need the routed Nova
127-
command surface from PowerShell, use <code>Invoke-NovaCli</code>.</p>
128-
<p><strong>Expected result:</strong> commands such as <code>Get-NovaProjectInfo</code>, <code>Invoke-NovaBuild</code>,
129-
and <code>nova</code> resolve in your PowerShell session.</p>
126+
<div class="surface-note" data-command-visibility="command-line" hidden>
127+
<p><strong>Command-line note:</strong> <code>Import-Module NovaModuleTools</code> does
128+
<strong>not</strong> create a <code>nova</code> command in your shell. On macOS/Linux, run
129+
<code>Install-NovaCli</code> before you expect <code>% nova ...</code> to resolve outside
130+
PowerShell.</p>
131+
</div>
132+
<p>After import, you can use the PowerShell cmdlets directly.</p>
133+
<p><strong>Expected result:</strong> commands such as <code>Get-NovaProjectInfo</code> and
134+
<code>Invoke-NovaBuild</code> resolve in your PowerShell session.</p>
130135
</section>
131136

132137
<section class="content-section" id="entrypoints">
@@ -145,18 +150,20 @@ <h2>3. Choose PowerShell or CLI entrypoints</h2>
145150
<tr>
146151
<td>PowerShell cmdlets in <code>pwsh</code></td>
147152
<td>You are already inside <code>pwsh</code>.</td>
148-
<td>Import the module once, then use cmdlets directly. Use <code>Invoke-NovaCli</code>
149-
only when you explicitly want the routed CLI surface from PowerShell.
150-
</td>
153+
<td>Import the module once, then use cmdlets directly.</td>
151154
</tr>
152155
<tr>
153156
<td>Standalone <code>nova</code> launcher</td>
154157
<td>You want to run Nova from zsh or bash on macOS/Linux.</td>
155-
<td>Install the launcher once with <code>Install-NovaCli</code>.</td>
158+
<td>Install the launcher once with <code>Install-NovaCli</code> before you expect
159+
<code>nova</code> to resolve in your shell.</td>
156160
</tr>
157161
</tbody>
158162
</table>
159163
</div>
164+
<p data-command-visibility="command-line" hidden><strong>Important:</strong>
165+
<code>Import-Module NovaModuleTools</code> loads cmdlets into PowerShell, but the standalone
166+
<code>nova</code> launcher is a separate install step on macOS/Linux.</p>
160167
<h3>Install the standalone launcher on macOS/Linux</h3>
161168
<pre><code>PS&gt; Install-NovaCli</code></pre>
162169
<p>By default, the launcher is installed to <code>~/.local/bin/nova</code>. If that directory is not
@@ -233,8 +240,8 @@ <h2>5. Build and test the example</h2>
233240
</section>
234241

235242
<section class="content-section" id="import-and-run">
236-
<h2>6. Import the built module and run a command</h2>
237-
<p>Now take the built module into the environment you want to use and run the example command.</p>
243+
<h2>6. Run the example command from the built or locally published module</h2>
244+
<p>Now take the generated module into the environment you want to use and run the example command.</p>
238245
<div class="surface-example" data-command-example>
239246
<div class="surface-example__meta">
240247
<p class="surface-example__title">Use the built module</p>

docs/index.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,12 @@ <h3>Concepts</h3>
187187
<h2>Recommended first 15-minute path</h2>
188188
<ol class="plain-list plain-list--ordered">
189189
<li>Install the module and import it into PowerShell.</li>
190-
<li>Scaffold the packaged example with <code>PS&gt; Initialize-NovaModule -Example</code>.</li>
191-
<li>Build with <code>PS&gt; Invoke-NovaBuild</code>.</li>
192-
<li>Test with <code>PS&gt; Test-NovaBuild</code>.</li>
193-
<li>Import the built example module and run <code>PS&gt; Get-ExampleGreeting</code>.</li>
190+
<li>If you want the <code>nova</code> launcher on macOS/Linux, install it with
191+
<code>Install-NovaCli</code>.</li>
192+
<li>Open <a class="text-link" href="./getting-started.html">Getting Started</a> and keep the page
193+
on your chosen PowerShell or command-line surface.</li>
194+
<li>Scaffold the packaged example, then build and test it.</li>
195+
<li>Run the example command from the built or locally published module.</li>
194196
</ol>
195197
<p>This path proves the tool works, shows the real folder structure, and gives you a runnable module
196198
before you start customizing anything.</p>

docs/troubleshooting.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -217,13 +217,14 @@ <h2>Build errors point into the generated <code>.psm1</code></h2>
217217
<h2><code>Install-NovaCli</code> says it is for macOS/Linux only</h2>
218218
<p><strong>Likely cause:</strong> that is the current intended behavior. The standalone launcher is for
219219
macOS/Linux shell use.</p>
220-
<p><strong>Fix:</strong> on Windows, import the module and use the PowerShell cmdlets directly. If you
221-
explicitly need the routed CLI surface from PowerShell, call <code>Invoke-NovaCli</code>.</p>
220+
<p><strong>Fix:</strong> on Windows, import the module and use the PowerShell cmdlets directly. The
221+
standalone <code>nova</code> launcher is a separate macOS/Linux install path, not something that
222+
appears automatically after <code>Import-Module</code>.</p>
222223
<pre><code>PS&gt; Import-Module NovaModuleTools
223224
PS&gt; Get-NovaProjectInfo
224-
PS&gt; Invoke-NovaCli version</code></pre>
225-
<p><strong>Success looks like:</strong> you can run Nova commands from PowerShell on Windows without
226-
installing the standalone launcher.</p>
225+
PS&gt; Invoke-NovaBuild</code></pre>
226+
<p><strong>Success looks like:</strong> the NovaModuleTools cmdlets work in your PowerShell session on
227+
Windows, and you do not need a separate launcher install for that workflow.</p>
227228
<p><a class="text-link" href="./getting-started.html#entrypoints">See entrypoint guidance</a></p>
228229
</section>
229230

docs/working-with-modules.html

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,11 +199,18 @@ <h2>Use local publish intentionally</h2>
199199
</ul>
200200
<p>Use local publish when you want to simulate a real installed-module experience. Use the normal
201201
build/import loop when you just want fast iteration in <code>dist/</code>.</p>
202-
<div class="notice notice--warning">
202+
<div class="notice notice--warning" data-command-visibility="powershell">
203203
<strong>Do not confuse local publish with local release.</strong>
204-
<p><code>Invoke-NovaRelease -Local</code> publishes locally too, but it
205-
does <strong>not</strong> import the published module into the current session afterward. That
206-
special import behavior belongs to <code>Publish-NovaModule -Local</code>.</p>
204+
<p><code>Publish-NovaModule -Local</code> reloads the published module into the current PowerShell
205+
session after success. <code>Invoke-NovaRelease -Local</code> publishes locally too, but it does
206+
<strong>not</strong> import the published module afterward.</p>
207+
</div>
208+
<div class="notice notice--warning" data-command-visibility="command-line" hidden>
209+
<strong>Do not confuse local publish with local release.</strong>
210+
<p><code>% nova publish --local</code> prepares a locally installed module that a fresh PowerShell
211+
session can resolve right away. <code>% nova release --local</code> also publishes locally, but
212+
it does <strong>not</strong> add the extra published-module import behavior described for the
213+
local publish workflow.</p>
207214
</div>
208215
</section>
209216

0 commit comments

Comments
 (0)