Browse Source

feat: improve quickstart guide copy

for example to include a note about switching off PRs elsewhere
master
DanConwayDev 2 years ago
parent
commit
89af75fd6e
No known key found for this signature in database
GPG Key ID: 68E15486D73F75E1
  1. 54
      src/routes/+page.svelte
  2. 28
      src/routes/quick-start/+page.svelte

54
src/routes/+page.svelte

@ -181,10 +181,7 @@ @@ -181,10 +181,7 @@
<Container>
<div class="prose m-auto mb-6 mt-6">
<h2>Quick Start</h2>
<h3>
Install <span class="text-purple-600">n</span>git and
<span class="text-yellow-600">git</span>-remote-nostr
</h3>
<h3>Install ngit and git-remote-nostr</h3>
<InstallNgit />
</div>
<div class="m-auto max-w-5xl">
@ -293,36 +290,45 @@ @@ -293,36 +290,45 @@
<span class="text-primary">my-repo</span></code
>
</div>
<div>
<code
><span class="text-yellow-600">git</span> remote set-url
origin nostr://<span class="text-purple-600">npub123</span
>/<span class="text-primary">my-repo</span></code
>
</div>
<div>
<code
><span class="text-green-600"
>// pushing merged commits updates proposal status</span
>// push to nostr and git server(s) via remote helper</span
></code
>
</div>
<div>
<code
><span class="text-yellow-600">git</span> merge origin/pr/great-feature(e8246b2)</code
>
</div>
<div>
<code><span class="text-yellow-600">git</span> push</code>
<div>
<code
><span class="text-yellow-600">git</span> remote set-url
origin nostr://<span class="text-purple-600">npub123</span
>/<span class="text-primary">my-repo</span></code
>
</div>
<div>
<code
><span class="text-green-600"
>// pushing merged commits updates proposal status</span
></code
>
</div>
<div>
<code
><span class="text-yellow-600">git</span> merge origin/pr/great-feature(e8246b2)</code
>
</div>
<div>
<code><span class="text-yellow-600">git</span> push</code>
</div>
</div>
</div>
</div>
</div>
<div class="card-actions mt-auto justify-end">
<a
href="/quick-start#maintainer"
class="btn btn-secondary text-right">full guide</a
>
<div class="card-actions mt-auto justify-end">
<a
href="/quick-start#maintainer"
class="btn btn-secondary text-right">full guide</a
>
</div>
</div>
</div>
</div>

28
src/routes/quick-start/+page.svelte

@ -224,7 +224,7 @@ @@ -224,7 +224,7 @@
<div>
<code
><span class="text-yellow-600">git</span> remote add origin
https://codeberg.org/johnedoe/my-repo.git</code
https://dm.co/usr/my-repo.git</code
>
</div>
<div>
@ -243,13 +243,23 @@ @@ -243,13 +243,23 @@
<ul>
<li>
<div>
<div>initialize and use the nostr remote:</div>
<div>initialize:</div>
<div class="not-prose text-sm">
<div>
<code
><span class="text-purple-600">ngit</span> init
</code>
</div>
</div>
</div>
</li>
<li>
<div>
<div>
use the nostr remote to push state to nostr and git
server(s):
</div>
<div class="not-prose text-sm">
<div>
<code
><span class="text-yellow-600">git</span> remote
@ -263,7 +273,7 @@ @@ -263,7 +273,7 @@
</li>
<li>
ensure all maintainers push to the nostr remote and not git
server directly so that the state is updated on nostr
server directly so that state on nostr remains in sync
</li>
</ul>
</div>
@ -348,6 +358,18 @@ @@ -348,6 +358,18 @@
</li>
</ul>
</div>
<h4>5. consider turning off PRs and issues elsewhere</h4>
<div>
<ul>
<li>
ie. on git server(s) so they are managed solely on nostr.
</li>
<li>
Note: for github use <code>Repo Settings &gt; Features</code> for
issues but turning off PRs isn't yet possible.
</li>
</ul>
</div>
</div>
</div>
</div>

Loading…
Cancel
Save