tangled.org / core
Monorepo for Tangled — https://tangled.org
fork atom

Docs: Getting Started #318

open
opened by byarielm.fyi

I know instructions for setting up git (or jj) + tangled exist somewhere but it's not in the docs / not obvious. While tangled is currently primarily used by existing developers, it would be beneficial for new developers to have clear guidelines on (1) how to get started - choosing git vs jj, setting up a new repo for new project, creating new repo on tangled for existing project, cloning a project, PRs, etc, and (2) tangled-specific terms vs. what's typically used.

This issue is inspired by my attempt to switch my repo from github as the origin to tangled and borking it up <3

anirudh.fi

Good idea! We want to improve the general docs story; a getting started page will be super handy.

byarielm.fyi (author)

Happy to review! These kinds of things I don't use often enough to have memorized naturally, and my memory is poor, so I usually just look for these docs or have my own version in my notes. Sadly, I didn't log any version in my notes for this, so not going to be very useful helping initiate the docs :')

jensroemer.com

@anirudh.fi there might also be some blog-post material here. "Tangled for non-developers" or "migrating from github to tangled" - or something along those lines. @byarielm.fyi do you remember where you borked it up? :-D

byarielm.fyi (author) edited

It was actually just the change to .org but my ssh files still had .sh and trying to change the remote triggered it to care lol. But I more recently setup things for a new repo on another device and have a log-ish of what I did, just need to work through and organize it now since there’s a lot that wasn’t right / didn’t work lol.

sign up or login to add to the discussion
Labels

None yet.

area

None yet.

assignee

None yet.

Participants 3
AT URI
at://did:plc:6i6n57nrkq6xavqbdo6bvkqr/sh.tangled.repo.issue/3m744a7zj5f22