Scribe Connect enables you to connect your codebase and wiki - alerting you to any relevant and potentially outdated documents on every Pull Request.

How it works

Just paste the url of a document into any code file and they are now connected.

https://3.basecamp.com/1234567/buckets/12345678/documents/1234567890
...

https://yourproject.atlassian.net/wiki/spaces/spaceName/pages/123456/title
...

Why this app exists

How many times have you written documentation that has become out of date and out of sync? Maybe you started adding markdown files to your codebase to bring your wiki closer to your code. But now you need a pipeline for converting that markdown to HTML so it's more readable. Even if you get that working you still need a wiki for more general documentation that non-techies can add to.

Put simply documentation has been a second class citizen in code projects for far too long. This GitHub App is the very first step on the journey to correcting that. I'm also working on a brand new wiki called Scribe that really takes these ideas and runs with them. If you want to know more about Scribe head over to https://scribe.wiki. It's not too far off an initial beta!