fix: restore interface setup docs and break circular references#673
Open
Mustafa-Esoofally wants to merge 9 commits into
Open
fix: restore interface setup docs and break circular references#673Mustafa-Esoofally wants to merge 9 commits into
Mustafa-Esoofally wants to merge 9 commits into
Conversation
The Slack, Telegram, and WhatsApp interface docs had circular references: - /agent-os/.../introduction linked to /deploy/.../overview for setup - /deploy/.../overview linked back to /agent-os/.../introduction for setup - Neither page had the actual setup steps (deleted in PR #644) This commit: - Creates dedicated setup.mdx pages under /deploy/interfaces/{slack,telegram,whatsapp}/ - Restores the full setup content that was deleted (BotFather, Meta App, Slack App setup steps) - Updates both introduction and overview pages to link to the new setup pages - Updates docs.json navigation to show nested Setup pages under each interface
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Revised approach based on docs structure review:
- Setup content now lives inline in agent-os/interfaces/{platform}/introduction.mdx
- Deploy overview pages stay lightweight (quick start) and link to agent-os for full setup
- Removed separate deploy/interfaces/{platform}/setup.mdx pages
- Reverted docs.json to flat interface structure (no nested groups)
This fixes the circular reference where deploy linked to agent-os and agent-os
linked back to deploy, with neither having the actual setup steps.
New flow:
- deploy/.../overview.mdx → agent-os/.../introduction.mdx#setup (one-way)
- Agent-OS introduction pages now have full inline <Steps> for setup
- Create setup.mdx pages in agent-os for Slack, Telegram, WhatsApp - Remove inline setup content from introduction pages - Update docs.json sidebar: Introduction → Setup → (HITL) → Reference - Update deploy overview links to point to new setup pages
Mustafa-Esoofally
force-pushed
the
fix/restore-interface-setup-docs
branch
from
c560562 to
022b214
Compare
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
Fixes circular reference bug in Slack, Telegram, and WhatsApp interface documentation.
The bug: Deploy overview pages said "see AgentOS for full setup" and AgentOS introduction pages said "follow the deploy guide for setup" — neither had the actual steps.
The fix: Move full setup steps inline into
agent-os/interfaces/{platform}/introduction.mdx. Deploy overview pages now link one-way to agent-os.Architecture
Changes
agent-os/interfaces/slack/introduction.mdxagent-os/interfaces/telegram/introduction.mdxagent-os/interfaces/whatsapp/introduction.mdxdeploy/interfaces/*/overview.mdxagent-os/.../introduction#setupdocs.jsonTest Plan
mintlify devand verify setup steps render inline in agent-os introduction pages