common problem: published doc for past release is immutable
-
Show this thread
-
domentation is a bunch of thingspic.twitter.com/nAMKeziMPe
1 reply 0 retweets 1 likeShow this thread -
"documentation should be maintained indenpendtly of code, but with reference to it" "doc ref a commit and is OK for all following commit until superseded or deleted" Hey
@antoraproject, this seems like a good idea!pic.twitter.com/8Jjs29UVjM
1 reply 0 retweets 3 likesShow this thread -
amok is a database of Metadatas (organized in trees linked to a git commit) that can be queried, a linkers for urls that can merge sparse trees together and build the doc. All in an universal namespace => several amok repo can be merged together
1 reply 0 retweets 2 likesShow this thread -
amok is low level, so you build applications on top of it, they can adapt semantic of metadatas. Tests are a good example of executed documentation that could be done in amokpic.twitter.com/ilxWdllHmX
1 reply 0 retweets 1 likeShow this thread -
current status: db works for simple case (branches, merges). Not for squash/rebase (b/c change hashes). Problem can be tooled away only if doc and code are managed together (git hook, etc). When you don't own the code repo: no idea for now ("be careful")
1 reply 0 retweets 1 likeShow this thread -
I forget to talk about the presentation layer. Current status: rendering raw, html, markdown... It works by recursively fetch content from amok.
1 reply 0 retweets 1 likeShow this thread -
amok is getting ideas from
#fury build manager. Amok. Fury. I see a pattern in latest@propensive naming scheme. Hope scala (or it's ecosystem) are not the source of the pattern :)pic.twitter.com/p2sUTrI2r8
1 reply 0 retweets 1 likeShow this thread -
(or perhaps that's only constructive fury / amok :)
1 reply 0 retweets 0 likesShow this thread -
all in all, amok seems to have a really good set of ideas. It seems to share a lot of
@antoraproject assements a/b doc (doc out of repo, multiple repo aggregation, code lifecy != doc lifecycle, etc). The link to precise hash in amok is interesting For ref: https://antora.org/2 replies 0 retweets 4 likesShow this thread
Thanks for that link! I'll explore it further...
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.