From 415e2392e191dbe11c3386688c180a8a5f39b404 Mon Sep 17 00:00:00 2001 From: Ryan Barrett Date: Sat, 30 Dec 2023 10:29:48 -0800 Subject: [PATCH] misc docs tweaks --- static/style.css | 8 ++++++-- templates/docs.html | 31 +++++++++++++++++++++++++------ templates/index.html | 7 +------ 3 files changed, 32 insertions(+), 14 deletions(-) diff --git a/static/style.css b/static/style.css index d2349e7..527ab76 100644 --- a/static/style.css +++ b/static/style.css @@ -187,6 +187,10 @@ pre .value, code .value, code.value { margin: .1em !important; } +.web, .fediverse { + white-space: nowrap; +} + .front-light .web { color: #20593c; } @@ -196,11 +200,11 @@ pre .value, code .value, code.value { } .front-dark .web { - color: #87d8a6; + color: #b7e4c6; } .front-dark .fediverse { - color: #d887a6; + color: #e4b7c6; } .fediverse img { diff --git a/templates/docs.html b/templates/docs.html index 330bca1..9c345b3 100644 --- a/templates/docs.html +++ b/templates/docs.html @@ -69,6 +69,12 @@
+

From the fediverse

+ +
  • How do I follow someone from the fediverse?
    • + +
    +

    To the fediverse

  • Which fediverse servers are supported?
    • @@ -112,7 +118,8 @@
  • How do I get started?
  • -

    Use these instructions to follow someone on another network. After that, interact with them normally! See below for more information and setup details.

    +

    If you're on the web, first set up your web site, then follow someone on the fediverse.

    +

    If you're on the fediverse, try following a web site.

  • Which accounts do I need?
    • @@ -183,8 +190,8 @@
  • How do I get started?
  • -

    If you have a web site, you're all set! Try following your site from the fediverse, then read on below for more details.

    -

    After that, we recommend that your site support webmentions. You can see a notifications feed of your interactions from other networks - replies, reposts, likes, etc - but to get them back to your site, it needs to support webmentions. Check out the IndieWeb wiki for instructions for your web server.

    • +

    First, connect your web site to Bridgy Fed. Then, try following your site from the fediverse. If that looks good, start following people in the fediverse! +

    We recommend that your site supports webmentions. You can see a notifications feed of your interactions from other networks - replies, reposts, likes, etc - but to get them back to your site, it needs to support webmentions. Check out the IndieWeb wiki for instructions for your web server.

    @@ -225,11 +232,13 @@
  • How does Bridgy Fed find my posts?
  • -

    Bridgy Fed can discover web site posts via webmentions and Atom/RSS feeds.

    + +

    Bridgy Fed discover posts on your web site via webmentions. Atom/RSS feed support is coming soon!

    -

    The first time someone follows a web site via Bridgy Fed, it looks for an Atom or RSS feed. If it finds one, it extracts and bridges those posts, then periodically checks for new posts.

    + -

    Instead of waiting for that periodic poll, you can bridge a new or updated post immediately by sending Bridgy Fed a webmention. Include a link to https://fed.brid.gy/ in your post, and if your web server supports webmentions, it should send one automatically. Alternatively you can send one manually.

    + +

    To bridge a new or updated post from your web site, send Bridgy Fed a webmention. Include a link to https://fed.brid.gy/ in your post, and if your web server supports webmentions, it should send one automatically. Alternatively you can send one manually.

    Here's example HTML for a post: @@ -455,6 +464,16 @@ To receive likes, reposts, replies, @-mentions, and follows from the fediverse,

    Yes! By default, your web site's bridged handle on other networks uses a subdomain of brid.gy, but you can use your own domain instead. Here are instructions for fediverse handles.

    +
    + +

    From the fediverse

    + +
  • How do I follow someone from the fediverse?
    • +
  • +

    You can follow any web site, eg example.com, by searching for @example.com@web.brid.gy in your fediverse instance.

    +

    Bridged web sites appear in the fediverse as either @[domain]@[domain], @[domain]@web.brid.gy, or @[domain]@fed.brid.gy, depending on the fediverse server and whether the web site owner has connected their domain to Bridgy Fed. All bridged web sites behave the same in the fediverse; the different instances in their handles are purely cosmetic.

    +
    • +

    To the fediverse

    diff --git a/templates/index.html b/templates/index.html index a17adbb..a5086f3 100644 --- a/templates/index.html +++ b/templates/index.html @@ -8,15 +8,12 @@
    -
    - Bridging the new
    social internet
    - -
    +

    Got a 🌐 web site? Enter it here to follow someone on the fediverse: @@ -35,8 +32,6 @@

    Bridgy Fed connects some of the most popular decentralized social networks. You can use it from one network to follow people on another, see their posts, and reply and like and repost them. All interactions work in both directions. See the docs for more info.

    - -

    Bridgy Fed currently supports web sites and blogs and the fediverse via ActivityPub. Bluesky/AT Protocol and Nostr are planned for 2024.