Skip to content

feat: add submodule: [web-agent] and intergate docs into doc site#82

Closed
chilingling wants to merge 2 commits intoopentiny:devfrom
chilingling:feat/intergateWebAgentDoc
Closed

feat: add submodule: [web-agent] and intergate docs into doc site#82
chilingling wants to merge 2 commits intoopentiny:devfrom
chilingling:feat/intergateWebAgentDoc

Conversation

@chilingling
Copy link
Member

@chilingling chilingling commented Feb 12, 2026

【描述】

  1. 增加 web-agent 子模块。
  2. 集成web-agent 子模块文档到 opentiny 文档。
image image

Summary by CodeRabbit

  • New Features

    • Added a new WebAgent documentation section with a getting-started guide and sidebar navigation.
    • Introduced a WebAgent product tab in the site navigation with automatic routing and a redirect to the guide.
  • UI

    • Increased top navigation width for better layout when the new tab is present.
  • Chores

    • Added web-agent as a project submodule.

@coderabbitai
Copy link

coderabbitai bot commented Feb 12, 2026

Walkthrough

The changes add a new Git submodule entry for "web-agent" to the repository. The .gitmodules configuration file registers the submodule with its remote URL, and the submodule commit reference is initialized with a specific commit hash.

Changes

Cohort / File(s) Summary
Submodule Configuration
.gitmodules, web-agent
Added new submodule entry for web-agent pointing to git@github.com:opentiny/web-agent.git and registered its commit reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A new friend hops into the fold,
Web-agent joins, brave and bold,
In .gitmodules it takes its place,
A submodule's gentle embrace! 🌿✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately reflects the main change: adding a web-agent submodule and integrating docs into the doc site, which aligns with the .gitmodules modification.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In @.vitepress/config.mts:
- Line 229: The rewrite rule 'web-agent/docs/:path*': 'web-agent/guide/:path*'
is dead because the web-agent directory has no docs/ or guide/ subdirectories;
either remove this rewrite entry from the rewrites config or create the expected
structure and markdown files under web-agent/docs (or web-agent/guide) so the
mapping points to real content—update or delete the 'web-agent/docs/:path*' →
'web-agent/guide/:path*' mapping accordingly.
🧹 Nitpick comments (2)
.vitepress/theme/components/CustomHeader.vue (2)

26-26: Inline style with magic number for tab container width.

The width was bumped from 810px to 980px to fit the new tab. This is fragile — adding another product tab in the future will require another manual adjustment. Consider using a CSS approach that adapts to content (e.g., max-width with flex layout). That said, this matches the existing pattern, so it's a pre-existing concern.


326-336: productPathMap entry for web-agent has different semantics than other entries.

Other entries in productPathMap list only non-guide sub-paths (e.g., "tiny-editor": ["/demo/", "/api/", "/modules/"]), so the guide tab is activated via currentTab matching. For web-agent, "/web-agent/" matches all paths including guide, making isProductRoute always true and activeNavTab always "guide". This works correctly today because there's only one tab, but the intent differs from the pattern. If more tabs are added later, this entry would need updating.

'tiny-editor/packages/docs/fluent-editor/docs/demo/:path*': 'tiny-editor/demo/:path*',
'tiny-editor/packages/docs/fluent-editor/docs/api/:path*': 'tiny-editor/api/:path*',
'tiny-editor/packages/docs/fluent-editor/docs/modules/:path*': 'tiny-editor/modules/:path*',
'web-agent/docs/:path*': 'web-agent/guide/:path*'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify the expected markdown files exist in the web-agent submodule
echo "=== Files in web-agent/docs/ ==="
fd -e md . web-agent/docs/ 2>/dev/null || echo "web-agent/docs/ not found or empty"
echo ""
echo "=== Looking for expected sidebar files ==="
for f in getting-started architecture api-reference; do
  if [ -f "web-agent/docs/${f}.md" ]; then
    echo "✓ web-agent/docs/${f}.md exists"
  else
    echo "✗ web-agent/docs/${f}.md MISSING"
  fi
done
echo ""
echo "=== Checking if web-agent/guide/ exists ==="
if [ -d "web-agent/guide/" ]; then
  echo "✓ web-agent/guide/ exists"
  fd -e md . web-agent/guide/ 2>/dev/null | head -20 || echo "No markdown files found"
else
  echo "✗ web-agent/guide/ NOT found"
fi

Repository: opentiny/docs

Length of output: 369


🏁 Script executed:

#!/bin/bash
echo "=== Checking if web-agent exists ==="
if [ -d "web-agent" ]; then
  echo "✓ web-agent directory exists"
  echo ""
  echo "=== Contents of web-agent/ ==="
  ls -la web-agent/ | head -30
  echo ""
  echo "=== All markdown files in web-agent ==="
  find web-agent -name "*.md" -type f 2>/dev/null | head -20
  echo ""
  echo "=== Directory structure of web-agent ==="
  tree -L 3 web-agent 2>/dev/null || find web-agent -type d | head -20
else
  echo "✗ web-agent directory NOT found"
  echo ""
  echo "=== Listing repository root ==="
  ls -la | grep -E "^d"
fi

Repository: opentiny/docs

Length of output: 382


Remove or fix the rewrite rule—both referenced paths don't exist.

The rewrite rule maps web-agent/docs/:path*web-agent/guide/:path*, but the web-agent directory is empty. Neither docs/ nor guide/ subdirectories exist, and no markdown files are present. This rule will never match any requests. Either initialize the submodule with the correct structure or remove the rule entirely.

🤖 Prompt for AI Agents
In @.vitepress/config.mts at line 229, The rewrite rule 'web-agent/docs/:path*':
'web-agent/guide/:path*' is dead because the web-agent directory has no docs/ or
guide/ subdirectories; either remove this rewrite entry from the rewrites config
or create the expected structure and markdown files under web-agent/docs (or
web-agent/guide) so the mapping points to real content—update or delete the
'web-agent/docs/:path*' → 'web-agent/guide/:path*' mapping accordingly.

@chilingling chilingling changed the title feat: add submodule: [web-agent] feat: add submodule: [web-agent] and intergate docs into doc site Feb 13, 2026
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.

2 participants