Skip to content

docs: link AI nav to Overview and restructure overview page#1022

Merged
tony-xlh merged 1 commit into
previewfrom
update-ai-overview
Jul 8, 2026
Merged

docs: link AI nav to Overview and restructure overview page#1022
tony-xlh merged 1 commit into
previewfrom
update-ai-overview

Conversation

@lyzhang0113

Copy link
Copy Markdown
Collaborator

What

Two changes to the AI documentation section:

Nav behavior (_data/full_tree.yml)

Make the AI sidebar entry link directly to the Overview page instead of only expanding. This matches the existing pattern used by Introduction, Hello World, and General Usage Guide — a parent node with both a path: and a childList:. The now-redundant "Overview" child is removed, so the tree is:

- name: AI
  path: /ai/overview.html
  childList:
    - name: Agent Skills
      path: /ai/agent-skills.html

Content (_articles/ai/overview.md)

  • Replace the ## How to Use wrapper with one ## subheading per method: Ask AI, Agent Skills, Use with LLMs — each now has its own anchor.
  • Fix typos: "buttton" → "button", "write codes" → "write code", "questions related to" → "questions about".
  • Add a short description to each method.

🤖 Generated with Claude Code

Make the "AI" sidebar entry link directly to the Overview page (matching
the Introduction/Hello World/General Usage Guide pattern of a parent node
with both a path and a childList), and drop the now-redundant "Overview"
child.

Rewrite overview.md: replace the "How to Use" wrapper with a subheading
per method (Ask AI, Agent Skills, Use with LLMs), fix typos, and add a
short description to each method.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the AI documentation section by making the AI sidebar node directly navigable to the Overview page, and by restructuring the AI Overview content into clearer, linkable sections.

Changes:

  • Update the sidebar tree so the AI parent node links to /ai/overview.html (and remove the redundant Overview child entry).
  • Restructure the AI Overview page into three top-level methods (Ask AI, Agent Skills, Use with LLMs) to provide clearer anchors and descriptions.
  • Fix minor typos and wording for clarity.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
_data/full_tree.yml Makes the AI nav entry clickable (links to the overview) while retaining its child navigation.
_articles/ai/overview.md Reorganizes the overview content into three dedicated sections with improved wording and corrected typos.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tony-xlh tony-xlh merged commit 6d763a6 into preview Jul 8, 2026
1 check passed
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