Refresh TagoDeploy docs for the rebranded SPA#90
Open
RicardoStoklosa wants to merge 16 commits into
Open
Conversation
Bump docusaurus-plugin-llms to 0.4.0 and enable generateMarkdownFiles so each doc page is exposed as a .md sibling. llms.txt links now point to those .md URLs (default addMdExtension behavior), which lets TagoDeploy and other consumers fetch the raw markdown for rendering. Preserves title and description front matter on generated files.
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.
Summary
Refresh the TagoDeploy documentation to match the rebranded React SPA (migrated off HTMX). Audited and rewrote the 23 docs the in-app docs panel links, created the 7 docs the SPA registry expects but had only as bundled local-fallback drafts, and corrected the orphan docs against the live UI.
Why
The docs were written against the old HTMX UI. Terminology, routes, form fields, and flows had drifted from the current SPA. The SPA docs panel (
packages/web/src/docs/registry.ts) also references 7 slugs that did not exist upstream and 1 (open-connectors) that does exist in the UI but was never linked.Test plan
specs/spa-survey.md(logged in as thefully-loadedseed account against the local stack)slugmatchingregistry.tsexactly (tokens, mqtt/connections, mqtt/instances, container/instances, webservice/overview, webservice/settings, webservice/instances)docs/tagodeploy.mdlink targets resolved (fixedservices/overview.mdtoservices/index.md)pnpm buildnot run here: this worktree's local dependency tree is broken independent of the docs (lockfile is gitignored; a fresh install resolves@docusaurus/theme-mermaid@3.10.1against core3.9.2and a webpack ProgressPlugin schema mismatch). Run the build in CI.Screenshots
No screenshot changes. The docs are largely text; the few existing image refs were left intact.
Breaking changes
None. Documentation only.
Risk (CIA)
Likelihood: 🟢 Low | Impact: 🟢 Low | Exposure: 🟢 Low
Documentation-only change; no code or schema affected.
Related
specs/spa-survey.mdspecs/orphans-disposition.mddocs/superpowers/specs/2026-05-29-tagodeploy-docs-refresh-design.md,docs/superpowers/plans/2026-05-29-tagodeploy-docs-refresh.mdtago-io/deploy: once these docs are live on docs.tago.io, wire anopen-connectorsDocsButton and remove the 7 now-redundant local fallbacks +TODO(docs)lines inregistry.ts.Notes for reviewers (from the audit)
mqtt/acl-permissions,mqtt/credentials,mqtt/topic-mappingsandcontainer/docker-image|environment-variables|network|runtimehave no standalone SPA page; they are sections of a parent screen. Kept as corrected cross-reference stubs. Seespecs/orphans-disposition.mdfor a consolidation recommendation.container/logsdocuments a page that does not exist in the SPA (logs are project-level). Flagged as a deletion candidate, not deleted.specs/orphans-disposition.md.