Skip to content

[Updating Documentation] New TagoIO Admin Interface #25

Open
Freddyminu wants to merge 21 commits into
betafrom
feat/nextAdminDocUpdates
Open

[Updating Documentation] New TagoIO Admin Interface #25
Freddyminu wants to merge 21 commits into
betafrom
feat/nextAdminDocUpdates

Conversation

@Freddyminu

@Freddyminu Freddyminu commented Oct 23, 2025

Copy link
Copy Markdown
Collaborator

Summary

Refreshes documentation across the TagoIO docs site: replaces outdated admin UI screenshots with current-interface images, adds a new Tago AI section, adds TDeploy API reference pages, reorganizes getting-started content into topic sections, and removes deprecated content. 991 files changed.

What changed

Tago AI docs (new section)

  • New section tagoio/tago-ai/ covering AI provider configuration, Tago AI usage, and MCP-powered IoT data integration
  • Added profiles/services/tago-ai-service.md documenting the service in profile settings

TDeploy API reference

  • Updated docs/api-tdeploy/ pages: create/delete/list/update MQTT clients, list project services, sidebar, and info page
  • Formatted with npm run fmt

Section reorganization

Moved standalone pages out of Getting Started into the sections they belong to (git tracks these as renames, so history is preserved):

  • getting-started/restful-api.md to api/restful-api.md
  • getting-started/tags-system.md to devices/tags-system.md
  • getting-started/entities.md to entities/managing-entities.md, plus a new entities/ section with an overview page
  • getting-started/secrets.md to security/secrets.md
  • getting-started/notification.md to tagorun/notification.md
  • Relabeled and repositioned category sidebars (_category_.json) to match the new layout

Image overhaul

  • 300+ new screenshots and GIFs reflecting the current admin interface
  • Consistent rounded-border style (rounded-image-*.png) across all new screenshots
  • Animated GIFs (peek_*.gif) added for key UI workflows
  • 250+ outdated screenshots removed
  • Static images renamed and reorganized under static/img/ and static/docs_imagem/

Styling and components

  • src/css/custom.css: added .rounded-image, .gif-wrapper, and .gif-image classes
  • src/theme/MDXComponents.tsx: custom <img> component that auto-wraps .gif files in a styled container

Content updates (pages across the Widgets, TagoRUN, Devices, Integrations, Tutorials, My Account, Dashboards, Actions, Profiles, Analysis, and Getting Started sections)

  • Map widget: documented GeoJSON location format and added stationary device guidance
  • Actions: improved trigger-by-usage-alert content (resource and service lists with links), added MQTT topic multi-condition behavior notes
  • Corrected UI location wording throughout to match the current admin layout
  • Grammar and naming fixes (TagoIO capitalization, typos)

Pages removed

  • using-the-device-emulator.md - content merged into device emulator docs
  • building-solutions.md, deploying-applications.md, how-it-works.md - consolidated into getting-started.md
  • thinxtra-xkit-for-sigfox.md - deprecated tutorial removed
  • ticket-severity-options.md + support/_category_.json - support section removed

Infrastructure

  • cdk/lambda/index.js: updated redirects for consolidated and removed pages
  • .github/workflows/beta-deploy.yml: updated deploy trigger branch

Test plan

  • npm install && npm run start
  • Tago AI section renders at /docs/tagoio/tago-ai/
  • TDeploy API reference renders at /docs/api-tdeploy/
  • Moved pages render at their new paths (/api/restful-api, /devices/tags-system, /entities/managing-entities, /security/secrets, /tagorun/notification)
  • Rounded image borders appear on updated screenshot pages
  • GIF animations display with wrapper styling
  • Redirects work for removed pages (/building-solutions, /deploying-applications, /how-it-works)
  • No broken image references in the affected sections

Risk (CIA)

Likelihood: ⚪ None | Impact: ⚪ None | Exposure: ⚪ None
Documentation-only PR; no application behavior change. CDK redirect changes only affect removed doc paths.

@Freddyminu Freddyminu requested a review from vitorfdl December 10, 2025 13:38
@Freddyminu Freddyminu changed the title Updating Documentation in preparation of new TagoIO Admin Interface [Updating Documentation] New TagoIO Admin Interface Dec 10, 2025
@Freddyminu Freddyminu force-pushed the feat/nextAdminDocUpdates branch from b570b11 to d278695 Compare April 9, 2026 20:08
Replace and clean up image assets across the documentation. Add CSS and
MDX component support for rounded borders on images and a GIF wrapper
that clips and styles animated content consistently.
Rewrite and expand instructions for actions, analysis, dashboards, devices,
widgets, getting-started, and tutorials. Updates include new screenshots,
clearer step-by-step guidance, and restructured content for better readability.
Apply grammar corrections, fix typos, standardize 'Tago' to 'TagoIO'
where appropriate, and make minor wording improvements across 170+
documentation pages.
@Freddyminu Freddyminu force-pushed the feat/nextAdminDocUpdates branch from f8623eb to a43a65f Compare April 9, 2026 20:42
vitorfdl and others added 9 commits April 13, 2026 12:26
Introduces a dedicated Tago AI section covering the assistant overview,
chat interface and modes (Read/Write/Full), and bring-your-own AI
provider configuration. Adds TagoAI requests to the Services table with
per-plan monthly limits, and cross-links the Analysis script editor and
debug console to the new pages.
- Corrected the title of the Tago AI Service for consistency.
- Replaced images with updated versions with grey borders.
docs: add Tago AI documentation section
…ance for map widget

- Add GeoJSON (Point) as recommended location format with coordinate order caution
- Keep legacy lat/lng format as still supported
- Fix "series" → "groups" terminology for grouping feature
- Add section on managing multiple stationary devices via accumulator device pattern
@Freddyminu Freddyminu force-pushed the feat/nextAdminDocUpdates branch from 902ba9e to 63afca8 Compare April 15, 2026 22:00
@Freddyminu Freddyminu requested review from felipefdl and removed request for PhilGutierre April 15, 2026 22:02
@Freddyminu Freddyminu changed the base branch from main to beta April 29, 2026 19:49
Freddyminu and others added 4 commits April 29, 2026 16:52
# Conflicts:
#	docs/tagoio/actions/trigger-by-mqtt-topic.md
docs: document GeoJSON location format and stationary device guidance for map widget
@Freddyminu Freddyminu self-assigned this May 19, 2026
- Renamed all rounded-image-* PNGs to descriptive kebab-case names based on doc context and visual content
- Renamed peek_* and other opaque GIF names to descriptive names
- Deleted ~170 orphaned images and GIFs not referenced by any doc
- Updated all image references across docs to match new filenames
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants