docs(apps): Tolgee Apps documentation (alpha)#1116
Draft
JanCizmar wants to merge 5 commits into
Draft
Conversation
New top-level "Apps" docs instance covering the alpha Tolgee Apps platform: - Introduction & architecture (install/enable/iframe/REST/webhooks/decorators, module types, limitations) - Setup & quickstart (create-tolgee-app, dev/register, enabling on a project) - API reference (manifest schema, SDK browser/server, postMessage, context token, webhook signature, decorators contract, scopes, REST endpoints, CLI) - Tutorial: activity monitoring app - Tutorial: back-translation QA app Every page is marked experimental. Wired into docs.js + navbar.js + sidebarTolgeeApps.js.
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…st-updated - 40–80 word plain-prose TL;DR directly under the H1 on every page. - FAQ section + FAQPage JSON-LD (via @docusaurus/Head) on intro, setup, and API pages. - Enable showLastUpdateTime on the Apps docs instance (visible "Last updated"). - Restate "Tolgee App(s)" in section/answer leads instead of bare "it"/"this".
A copy-paste prompt for an AI coding agent that reads the Apps docs, asks the user a few questions about the app, scaffolds it with create-tolgee-app (keeping the default Tolgee URL), pulls local context, builds with the typed SDK + typecheck, and hands dev/register back to the user. Sits above the manual quickstart steps.
New iframe module shown when no cell is selected; document the module in the list and add selectedLanguages to TolgeeAppSelection and the message payloads.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new top-level Apps documentation section for the (alpha) Tolgee Apps plugin platform.
Pages
create-tolgee-app, the dev tunnel + browser register flow, enabling on a project, local-dev notes.@tolgee/apps-sdkbrowser/server, postMessage protocol, context token, webhook signature, decorators contract, scopes, REST endpoints, thetolgee-appCLI.Wired into
docs.js,navbar.js, and a newsidebarTolgeeApps.js.npm run buildpasses (no broken links/anchors).The Tolgee Apps platform is unmerged/alpha (packages published under the npm `alpha` tag). Every page carries an experimental callout. This PR should stay draft and only merge once the apps feature ships.
Known follow-ups (not blocking this PR)