at least a little docs

This commit is contained in:
jonny 2023-11-29 11:57:57 +00:00
parent b4fd7c2080
commit 0840208900
1 changed files with 21 additions and 2 deletions

View File

@ -1,8 +1,27 @@
# wiki-postbot
Bot to add tweets using an extended wikilink syntax to the wiki
Bot to crosspost from chat clients and microblogs using an extended wikilink syntax to the (media)wiki.
eg. say `Hey what up i'm [[wikilinkin]]` in slack, and embed that message with a backling on the `wikilinkin` page.
Sorry for the extremely crappy docs and code structure y'all, this was supposed to be an internal tool for like 5 different projects, so i have done nothing yet to make it readable or reusable. the best way to understand this package for now would probably be to work backwards from the script entrypoints (see https://git.jon-e.net/jonny/wiki-postbot/src/branch/main/pyproject.toml#L11 ).
> this is not a model directed project, since it hasn't been intended to outlive the immediate circumstances each time, but it ends up doing so anyway.
>
> discord entrypoint is this: https://git.jon-e.net/jonny/wiki-postbot/src/branch/main/wiki_postbot/clients/discord.py
>
> main thing it does is transcribe messages onto wiki pages, this is the parser for those:
> https://git.jon-e.net/jonny/wiki-postbot/src/branch/main/wiki_postbot/patterns/wikilink.py
>
> it was designed to have a little microsyntax for selecting n-back post ranges and handling semantic wikilinks contextually but i haven't been able to implement that on the client side yet.
>
> wiki interface is here: https://git.jon-e.net/jonny/wiki-postbot/src/branch/main/wiki_postbot/interfaces/mediawiki.py
>
> specifically incoming from discord here: https://git.jon-e.net/jonny/wiki-postbot/src/commit/b4fd7c2080f2c3f2af6f215705083368ceef18d8/wiki_postbot/interfaces/mediawiki.py#L164
> so ideally that would, yno, have a data model that it juices things into, so i'm going to work those scraps into an n-to-m bridger that i was experimenting with a lil service version of here: https://git.jon-e.net/jonny/chatbridge
> - https://neuromatch.social/@jonny/111476292383009212
Starting with twitter, but then will add masto
# Mediawiki