- A software project maintains its documentation in a Git repository.
- The master version of a file is the canonical version of this documentation
- We want to use Discourse to facilitate collaborative edition and criticism of the living document
- Copy the link to the raw markdown file from the Git repository, e.g.,
https://git.example/org/documentation/raw/master/INSTALL.mdin the new topic title field
- Discourse retrieves title and markdown content that becomes topic content
- Discourse watches for changes and rebuilds HTML when needed, maintaining versions
Then the readers always have access to the latest markdown version in Git, while editors can use the power of Discourse to discuss changes.
Down the road
When ActivityPub support is added to Discourse and Git (via ForgeFed), this type of integration can be expanded to include cross-application document synchronization, without the need to know about Git.
The first step is to “onebox” external markdown. This would as well allow to integrate with a static blog directly from it’s Git repository, consolidating the publication process (i.e., by generating topics matching static pages at publication time)
What current solutions (API calls?) exist to do this besides embedding comments on the static page? How far from embed.js would that lead us?