How Data Flows between TileDocs and GitHub
Data Flow
When you install the TileDocs GitHub App to your GitHub account, TileDocs generates a temporary access token to interact with your selected repositories.
This token is used exclusively by the TileDocs Editor running in your browser, enabling a direct interaction with your GitHub repository without any data passing through TileDocs servers.
This ensures that your documentation remains secure, as it is neither read nor stored on any TileDocs infrastructure. All data flow happens directly between your browser and GitHub.
Data Flow
A Step-By-Step Breakdown
GitHub App Installation
You install the TileDocs GitHub App in your GitHub account and grant it access to specific repositories (read and write permissions only).
Token Generation
When you choose to connect your project to GitHub in the TileDocs Editor, a temporary access token is generated by GitHub. This token provides the necessary permissions to the TileDocs Editor.
Direct Browser Interaction
The temporary token is passed directly to the TileDocs Editor running in your browser. Using this token, the editor interacts directly with your GitHub repository to push or pull data.
No Server Intermediary
TileDocs servers are never involved in the data flow. Your documentation data remains within your browser or on GitHub, ensuring complete privacy. TileDocs doesn’t have access to your project content at any stage.
Pushing Data
When you save your project, the editor uses the token to push all your changes to the connected GitHub repository.
Pulling Data
If you need to access the project from another browser, the editor can use the token to pull the latest project version directly from GitHub.
This system ensures that all your project data is secure, processed only within your browser, and stored directly in your GitHub repository, giving you full control and privacy over your documentation.