docs(site): consolidate platform-specific docs into unified guides#2708
Draft
yuyutaotao wants to merge 1 commit into
Draft
docs(site): consolidate platform-specific docs into unified guides#2708yuyutaotao wants to merge 1 commit into
yuyutaotao wants to merge 1 commit into
Conversation
Merge each non-web platform's introduction, getting-started, and API
reference into one page (/android, /ios, /harmony, /computer) and group
them under a "More platforms" sidebar section. Web keeps its multi-doc
section unchanged.
- Each platform page now covers intro + setup + full API reference, with
the API reference under a `## API reference {#api-reference}` heading.
- Update cross-links in api/faq/quick-start/automate/integrate/changelog
(en + zh) to the new anchors.
- Add client redirects from the old *-introduction / *-getting-started /
*-api-reference paths (en + zh) and repoint existing redirects.
- Point the homepage mobile CTA link to /android.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Fg6vPKPGaBi8iSobKTUjCr
Collaborator
Author
|
Preview deployment https://claude-wonderful-turing-226i.midscene.pages.dev |
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
2 participants
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
Consolidates platform-specific documentation by merging separate "Introduction" and "Getting Started" pages into unified guides for each platform (Computer/PC Desktop, Android, iOS, HarmonyOS). This reduces documentation fragmentation and improves navigation structure.
Key Changes
Merged documentation files:
computer-introduction.mdx+computer-getting-started.mdx→computer.mdxandroid-introduction.mdx+android-getting-started.mdx→android.mdxios-introduction.mdx+ios-getting-started.mdx→ios.mdxharmony-introduction.mdx+harmony-getting-started.mdx→harmony.mdxen/) and Chinese (zh/) documentation treesRemoved separate API reference pages (content will be integrated into main guides):
computer-api-reference.mdxandroid-api-reference.mdxios-api-reference.mdxharmony-api-reference.mdxUpdated navigation structure (
rspress.config.ts):#api-reference)Updated cross-references throughout documentation:
api.mdx,automate-with-scripts-in-yaml.mdx,integrate-with-any-interface.mdx,quick-start.mdx,faq.md, andchangelog.mdxupdated to reference new consolidated page locationsImplementation Details
Each consolidated guide now includes:
#api-referenceanchors)Maintained all original content; no information was removed, only reorganized
Both English and Chinese documentation trees kept in sync
Validation
pnpm run lint(docs-only changes)https://claude.ai/code/session_01Fg6vPKPGaBi8iSobKTUjCr