-
-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Refactor project into a bilingual VitePress documentation site #270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
yancongya
wants to merge
18
commits into
x1xhlol:main
Choose a base branch
from
yancongya:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
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
Added comprehensive prompt and tool usage documentation for multiple AI coding agents in both English and Chinese under the docs directory. Includes system prompts, tool usage guidelines, agent-specific instructions, and supporting assets for various agents such as Amp, Claude, GPT-5, and others.
Introduced a 'build' script that runs 'vitepress build docs' to streamline documentation building. This provides a standard 'npm run build' command for the project.
The build script now uses 'npx vitepress build docs' to ensure the correct VitePress binary is used, improving compatibility and reliability.
Changed the build script in package.json to invoke the VitePress binary directly via node instead of using npx. This can improve reliability in certain environments where npx behavior may vary.
Wrapped <replace_in_file> usage examples in XML code blocks for improved readability and clarity in the documentation.
Wrapped all tool usage examples in XML code blocks for improved clarity and consistency. This helps users better understand the expected format for tool requests.
Added a new AI tools list markdown file. Updated VitePress config to rename the Chinese site title. Enhanced custom CSS with entrance animations for feature cards and timeline items. Improved and expanded the about pages in both English and Chinese, including a more detailed implementation roadmap and project summary. Updated homepages to clarify project purpose, tool coverage, and feature descriptions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
10 - 🌐 Bilingual Support: Full support for both English (
en-US) and Chinese (zh-CN) hasbeen added. All documents, homepages, and navigation elements are internationalized.
11 - 🎨 Modern UI:
12 - A new homepage has been designed, featuring a
herosection and card-based navigation.13 - Full dark/light mode support is implemented, including an adaptive logo.
14 - A smooth hover effect has been added to the homepage cards for better interactivity.
15 - 📄 Separate 'About' Page: A dedicated 'About' page (
/about) has been created, featuringa dynamic timeline and descriptive text to showcase the secondary development journey of this
project.
16 - 🧭 Improved Navigation:
17 - The "Prompts" link in the navigation bar has been converted into a dropdown menu,
categorized by AI tool for easier access.
18 - A site-wide footer with copyright information has been added.
19 - 🤖 Semi-Automated Sync Workflow:
20 - A new GitHub Action (
sync-check.yml) has been added. It can be triggered manually or ona schedule to automatically check for updates from the upstream repository.
21 - When updates are detected, the Action generates a folder (
upstream_updates) containingall changed files and a summary, then commits it to the repository for easy manual review and
synchronization.
22 - 📝 Updated Documentation:
23 - The root
README.mdhas been rewritten to reflect all the new features and provide abetter project overview, while clearly preserving attribution to the original author and
repository.
24 - The
FUNDING.ymlfile has been updated to include new sponsorship information.25
26 ## How to Test Locally
27
28 1. Clone this branch to your local machine.
29 2. Run
npm installto install all dependencies.30 3. Run
npm run docs:devto start the development server.31 4. Open
http://localhost:5173in your browser.32
33 Looking forward to your feedback!