Monorepo for Tangled tangled.org

docs: add getting started guide for tangled strings #1124

open opened by murex.tngl.sh targeting master from murex.tngl.sh/tangled: docs/strings
  • Add "Using Tangled Strings" section covering creation, viewing, editing.
  • Link from readme.

Addresses #194

Labels

None yet.

assignee

None yet.

Participants 1
AT URI
at://did:plc:owyua2lvxbs55wyhs22dqu2s/sh.tangled.repo.pull/3mgjtv56z4q22
+61
Diff #0
+60
docs/DOCS.md
··· 278 278 git push tangled main 279 279 ``` 280 280 281 + # Using Tangled Strings 282 + 283 + Tangled Strings are text snippets you can create, share, and store on 284 + Tangled. They live on your AT Protocol identity (your PDS), so you own 285 + your data and can share links that others can view, star, and access in 286 + raw form. 287 + 288 + ## What are Strings for? 289 + 290 + Strings are useful for: 291 + 292 + - **Code snippets** – Share a small script, config, or example without 293 + creating a full repo 294 + - **Pastebin-style sharing** – Quick sharing of logs, error output, or text 295 + - **Notes and docs** – Short notes, recipes, or how-tos you want to share 296 + publicly 297 + - **Markdown content** – Use a `.md` filename and your string will render 298 + as Markdown 299 + 300 + Each string has a filename, optional description, and contents. You can 301 + edit and delete your strings anytime. 302 + 303 + ## Finding Strings 304 + 305 + - **All strings** – Visit [tangled.org/strings](https://tangled.org/strings) 306 + to see a timeline of recent strings from all users 307 + - **Your strings** – Go to your profile and open the **Strings** tab, or 308 + visit `tangled.org/{your-handle}?tab=strings` 309 + - **Someone else's strings** – Open their profile and click the **Strings** 310 + tab 311 + 312 + ## Creating a String 313 + 314 + 1. Log in to [tangled.org](https://tangled.org) 315 + 2. Go to [/strings/new](https://tangled.org/strings/new) 316 + 3. Fill in: 317 + - **Filename** – A short name (e.g. `hello.sh`, `notes.md`, `config.json`) 318 + - **Description** – Optional; helps others understand what the string is 319 + - **Contents** – Your text or code 320 + 4. Click **Publish** 321 + 322 + Your string gets a unique URL like 323 + `tangled.org/strings/user.tngl.sh/3abc123xyz` that you can share. 324 + 325 + ## Viewing a String 326 + 327 + - **Rendered** – By default, Markdown files (`.md`) are rendered. Use the 328 + **view rendered** / **view code** toggle to switch. 329 + - **Raw** – Click **view raw** to get plain text, useful for copying or 330 + `curl`-ing. 331 + - **Stars** – You can star strings you find useful; they appear in your 332 + starred list. 333 + 334 + ## Editing and Deleting 335 + 336 + - **Edit** – If you own the string, use the **edit** button to change the 337 + filename, description, or contents. 338 + - **Delete** – Use the **delete** button to remove the string. This action 339 + cannot be undone. 340 + 281 341 # Knot self-hosting guide 282 342 283 343 So you want to run your own knot server? Great! Here are a few prerequisites:
+1
readme.md
··· 10 10 11 11 ## docs 12 12 13 + - [using Tangled Strings](https://docs.tangled.org/using-tangled-strings.html#using-tangled-strings) 13 14 - [knot hosting guide](https://docs.tangled.org/knot-self-hosting-guide.html#knot-self-hosting-guide) 14 15 - [contributing guide](https://docs.tangled.org/contribution-guide.html#contribution-guide) **please read before opening a PR!** 15 16 - [hacking on tangled](https://docs.tangled.org/hacking-on-tangled.html#hacking-on-tangled)

History

1 round 0 comments
sign up or login to add to the discussion
murex.tngl.sh submitted #0
1 commit
expand
docs: add getting started guide for tangled strings
no conflicts, ready to merge
expand 0 comments