Scribe Connect

Scribe Connect lets you connect your codebase and wiki!

Scribe Connect allows you to connect any file in your codebase to a document in your wiki. You just paste the document URL anywhere in the code file you want connected, and on every PR including this file we will do a check to see if you have updated that document. We will flag any code changes that have an associated document that hasn't been updated.

Why?

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.

I'm currently working on a brand new wiki called Scribe that allows you to connect documentation to the thing it's documenting. I want documentation to become a first class citizen in your project. This GitHub App is the very first step in that journey. If you want to know more about Scribe head over to https://scribe.wiki. It's not too far off an initial beta!

Notes

• Supports Confluence and BaseCamp
• Does not support Notion as they haven't finished adding an API