🚧 docs: architecture

[gr2m]

Preview

Created with https://excalidraw.com/. You can open the probot-architecture.json file and edit it

Follow up to #1452 (comment) /cc @shaftoe

Note that @probot/server and @probot/app do not yet exist. They currently are both implemented in the probot core package, in src/server.ts and src/probot.ts. And Probot does not yet use @octokit/app. But that is the next step, so I thought I'll lay out where we want to go, and fill in the blanks for anyone who has questions until then.

[request-info]

Thanks for opening this, but we'd appreciate a little more information. Could you update it with more details?

[shaftoe]

Thanks for this, it helps already a lot to get started to have a look at the code base. I'll use this as reference now and see how far I can get while note down questions that will arise, then will ping back.

By the way, I don't know the effort needed to keep this document up to date but I believe it has true value for anybody else who wants to dig deeper into the project. On the other end, if not kept up to date, it might have the opposite effect, so probably we should make visible directly in the doc at least the API version is meant for.

[gr2m]

By the way, I don't know the effort needed to keep this document up to date but I believe it has true value for anybody else who wants to dig deeper into the project. On the other end, if not kept up to date, it might have the opposite effect, so probably we should make visible directly in the doc at least the API version is meant for.

I want to add the diagram to the docs, together with instructions how to edit it. You can upload the static/architecture/probot-architecture.json file to https://excalidraw.com/ for editing

Excalidraw

Excalidraw

Excalidraw is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.