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. 14
      src/routes/+page.svelte
  2. 28
      src/routes/quick-start/+page.svelte

14
src/routes/+page.svelte

@ -181,10 +181,7 @@
<Container> <Container>
<div class="prose m-auto mb-6 mt-6"> <div class="prose m-auto mb-6 mt-6">
<h2>Quick Start</h2> <h2>Quick Start</h2>
<h3> <h3>Install ngit and git-remote-nostr</h3>
Install <span class="text-purple-600">n</span>git and
<span class="text-yellow-600">git</span>-remote-nostr
</h3>
<InstallNgit /> <InstallNgit />
</div> </div>
<div class="m-auto max-w-5xl"> <div class="m-auto max-w-5xl">
@ -293,6 +290,14 @@
<span class="text-primary">my-repo</span></code <span class="text-primary">my-repo</span></code
> >
</div> </div>
<div>
<code
><span class="text-green-600"
>// push to nostr and git server(s) via remote helper</span
></code
>
</div>
<div>
<div> <div>
<code <code
><span class="text-yellow-600">git</span> remote set-url ><span class="text-yellow-600">git</span> remote set-url
@ -327,6 +332,7 @@
</div> </div>
</div> </div>
</div> </div>
</div>
</div></Container </div></Container
> >

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

@ -224,7 +224,7 @@
<div> <div>
<code <code
><span class="text-yellow-600">git</span> remote add origin ><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>
<div> <div>
@ -243,13 +243,23 @@
<ul> <ul>
<li> <li>
<div> <div>
<div>initialize and use the nostr remote:</div> <div>initialize:</div>
<div class="not-prose text-sm"> <div class="not-prose text-sm">
<div> <div>
<code <code
><span class="text-purple-600">ngit</span> init ><span class="text-purple-600">ngit</span> init
</code> </code>
</div> </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> <div>
<code <code
><span class="text-yellow-600">git</span> remote ><span class="text-yellow-600">git</span> remote
@ -263,7 +273,7 @@
</li> </li>
<li> <li>
ensure all maintainers push to the nostr remote and not git 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> </li>
</ul> </ul>
</div> </div>
@ -348,6 +358,18 @@
</li> </li>
</ul> </ul>
</div> </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> </div>
</div> </div>

Loading…
Cancel
Save