From c10d0c97d7b05acfad44e0a26c90db29693d1a39 Mon Sep 17 00:00:00 2001 From: Ryan Barrett Date: Tue, 26 Sep 2023 13:32:27 -0700 Subject: [PATCH] noop: misc minor doc tweaks --- convert.py | 5 ++++- docs/index.rst | 20 +++++++++++--------- superfeedr.py | 8 +++++--- 3 files changed, 20 insertions(+), 13 deletions(-) diff --git a/convert.py b/convert.py index b7bcc91..f4b0c1d 100644 --- a/convert.py +++ b/convert.py @@ -102,7 +102,10 @@ def render_redirect(): @app.get(f'/convert///') def convert_source_path_redirect(src, dest, _): - """Old route that included source protocol in path instead of subdomain.""" + """Old route that included source protocol in path instead of subdomain. + + DEPRECATED! Only kept to support old webmention source URLs. + """ if Protocol.for_request() not in (None, 'web'): # no per-protocol subdomains error(f'Try again on fed.brid.gy', status=404) diff --git a/docs/index.rst b/docs/index.rst index 0ab8aa3..80cc370 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -92,25 +92,27 @@ How to add a new protocol the existing tables in the docs `__ in a PR. This is an important step before you start writing code. -2. If the new protocol uses a new data format - which is likely - add +2. Implement the id and handle conversions in + `ids.py `__. +3. If the new protocol uses a new data format - which is likely - add that format to `granary `__ in a new file with functions that convert to/from `ActivityStreams 1 `__ and tests. See - `nostr.py `__ + `nostr.py `__ and - `test_nostr.py `__ + `test_nostr.py `__ for examples. -3. Implement the protocol in a new ``.py`` file as a subclass of both +4. Implement the protocol in a new ``.py`` file as a subclass of both `Protocol `__ and `User `__. Implement the ``send``, ``fetch``, ``serve``, and ``target_for`` - methods from ``Protocol`` and ``handle``, ``web_url``, - ``ap_address``, and ``ap_actor`` from ``User`` . -4. TODO: add a new usage section to the docs for the new protocol. -5. TODO: does the new protocol need any new UI or signup functionality? + methods from ``Protocol`` and ``handle`` and ``web_url`` from + ``User`` . +5. TODO: add a new usage section to the docs for the new protocol. +6. TODO: does the new protocol need any new UI or signup functionality? Unusual, but not impossible. Add that if necessary. -6. Add the new protocol’s logo to ``static/``, use it in +7. Add the new protocol’s logo to ``static/``, use it in `templates/user.html `__. Stats diff --git a/superfeedr.py b/superfeedr.py index 745666c..9592a4c 100644 --- a/superfeedr.py +++ b/superfeedr.py @@ -1,8 +1,10 @@ """Superfeedr callback handlers. -Not really sure what this will be yet. Background: -https://github.com/snarfed/bridgy-fed/issues/18#issuecomment-430731476 -https://documentation.superfeedr.com/publishers.html +Not really sure what this will be yet. + +* https://github.com/snarfed/bridgy-fed/issues/550 +* https://github.com/snarfed/bridgy-fed/issues/18#issuecomment-430731476 +* https://documentation.superfeedr.com/publishers.html """ import logging