rewrite#3
Merged
def-WA2025 merged 14 commits intoMay 1, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/6160bb51-f3e1-42ac-9a73-6c347813d3f9 Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/6160bb51-f3e1-42ac-9a73-6c347813d3f9 Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/50cb9ae8-4540-4362-8bcb-e8ab42ca429e Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/eb49bb44-1a27-4e25-94ae-ef1df73fdc18 Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/39cacf77-dc43-4016-9311-f11137134a8d Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/6c49dfe8-b721-45ea-9c4a-187134ec1c5a Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
2 tasks
Copilot created this pull request from a session on behalf of
PythonSmall-Q
April 25, 2026 07:44
View session
There was a problem hiding this comment.
Pull request overview
This PR replaces the existing Writerside-based documentation setup with a VitePress site, updates CI to build/deploy the docs to GitHub Pages, and adds PR preview deployments via FTP with per-PR directories and cleanup on PR close.
Changes:
- Migrate documentation source/content from Writerside to VitePress (new
.vitepressconfig/theme + reorganized Markdown pages + new public assets). - Update GitHub Pages build workflow to run
npm run docs:buildand publish.vitepress/dist. - Add PR preview workflow that builds docs and deploys to
pr-{N}/on an FTP host, plus a cleanup workflow to delete that directory when PRs close.
Reviewed changes
Copilot reviewed 39 out of 45 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| qa/discussion.md | Adds VitePress FAQ page for discussion/DM troubleshooting. |
| public/logo.png | Adds site logo asset used by VitePress config. |
| public/badge.png | Adds badge example image for community docs page. |
| package.json | Introduces VitePress build/dev scripts and dependency. |
| legal/eula.md | Adds EULA page in new docs structure. |
| index.md | Adds VitePress home page frontmatter + feature cards. |
| guide/installation.md | Adds installation guide content for the new docs site. |
| features/rating.md | Adds rating feature documentation (includes a math formula). |
| features/index.md | Adds feature overview page. |
| features/image-hosting.md | Adds image hosting feature documentation. |
| features/get-data.md | Adds “get test data” feature documentation. |
| features/auto-handin.md | Adds “auto hand-in” feature documentation. |
| community/contributing.md | Adds contribution guidelines page. |
| community/badges.md | Adds badge/tag documentation page referencing /badge.png. |
| apps/messages.md | Adds “messages web app” documentation page. |
| apps/elxmoj.md | Adds ELXMOJ desktop client documentation page. |
| Writerside/xd.tree | Removes Writerside TOC/instance profile. |
| Writerside/writerside.cfg | Removes Writerside project configuration. |
| Writerside/v.list | Removes Writerside variable list. |
| Writerside/topics/docs/q&a/discussion.md | Removes old Writerside Q&A discussion doc. |
| Writerside/topics/docs/joinus.md | Removes old Writerside contributing/join page. |
| Writerside/topics/docs/index.md | Removes old Writerside landing page. |
| Writerside/topics/docs/functions/rating.md | Removes old Writerside rating doc. |
| Writerside/topics/docs/functions/pics.md | Removes old Writerside image hosting doc. |
| Writerside/topics/docs/functions/data.md | Removes old Writerside data feature doc. |
| Writerside/topics/docs/functions/auto-handin.md | Removes old Writerside auto-handin doc. |
| Writerside/topics/docs/eula.md | Removes old Writerside EULA doc. |
| Writerside/topics/docs/ads.md | Removes old Writerside ads page. |
| Writerside/topics/Installation.md | Removes old Writerside installation stub. |
| Writerside/topics/Badges.md | Removes old Writerside badges page. |
| Writerside/redirection-rules.xml | Removes Writerside redirection rules. |
| Writerside/cfg/glossary.xml | Removes Writerside glossary config. |
| Writerside/cfg/buildprofiles.xml | Removes Writerside build profiles config. |
| Writerside/c.list | Removes Writerside categories list. |
| .vitepress/theme/style.css | Adds custom GitHub/Primer-inspired VitePress styling. |
| .vitepress/theme/index.js | Loads the custom theme stylesheet. |
| .vitepress/config.mts | Adds VitePress site config (nav/sidebar/search/footer/edit link). |
| .gitignore | Ignores Node/VitePress build outputs and cache. |
| .github/workflows/test.yml | Adds CI workflow to build docs on PRs and non-master pushes. |
| .github/workflows/preview.yml | Adds PR preview build + FTP deploy + PR comment link. |
| .github/workflows/preview-cleanup.yml | Adds PR-closed cleanup job to delete FTP preview directory. |
| .github/workflows/build.yml | Replaces Writerside build with Node/VitePress build and Pages publish. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
@copilot ftp服务器上我只看到了文件夹我没有看到任何文件，也没有index页面。跳转链接给有index的 |
Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/4889807d-b58c-4e84-a7c1-336e45b750aa Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Contributor
Author
InfinityFree 的 FTP 根目录本身不对外提供 Web 服务，文件必须放在 |
Member
|
@copilot css不显示，链接导航有问题 |
… in subdirectory Agent-Logs-Url: https://github.com/XMOJ-Script-dev/docs/sessions/85ada21c-c8d8-43ef-8ac7-fcffa87c67c5 Co-authored-by: PythonSmall-Q <106425289+PythonSmall-Q@users.noreply.github.com>
Contributor
Author
VitePress 默认生成绝对路径的静态资源（如 |
PythonSmall-Q
approved these changes
Apr 25, 2026
PythonSmall-Q
changed the title
boomzero
requested changes
Apr 25, 2026
Updated warning message about known bugs and data retrieval issues.
Member
|
@PythonSmall-Q 给个权限我改一改latex显示 |
Member
|
done |
def-WA2025
approved these changes
May 1, 2026
Member
|
@PythonSmall-Q Merge? |
Member
|
不要随便merge，我还没预览过（）
Message ID: ***@***.***>
|
Member
|
不是我预览过了 |
Member
|
我还没看过（）
在 2026-05-02 10:02:24，"zsTree" ***@***.***> 写道：
def-WA2025 left a comment (XMOJ-Script-dev/docs#3)
不是我预览过了
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications on the go with GitHub Mobile for iOS or Android.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Member
|
我是不是要改一下开发者模式的那一段 |
Member
|
还有这是什么图片链接 |
Member
|
你改吧图片你加上就行我之前忘记了
在 2026-05-02 10:36:51，"zsTree" ***@***.***> 写道：
def-WA2025 left a comment (XMOJ-Script-dev/docs#3)
还有这是什么图片链接
—
Reply to this email directly, view it on GitHub, or unsubscribe.
Triage notifications on the go with GitHub Mobile for iOS or Android.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
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
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.
📖 文档预览
构建成功！点击下方链接在线预览文档（PR 关闭后自动删除）。
🔗 在线预览
Replace artifact-based PR previews with live FTP deployment to
xmoj-docs.infinityfreeapp.com. Each PR gets an isolated directory; closing the PR deletes it automatically.Changes
preview.ymlactions/upload-artifactforSamKirkland/FTP-Deploy-Action@v4.3.5.vitepress/dist/→pr-{N}/onftpupload.net:21usingFTP_USERNAME/FTP_PASSWORDsecretshttp://xmoj-docs.infinityfreeapp.com/pr-{N}/(live URL, not a download)preview-cleanup.yml(new)pull_request: [closed]lftptorm -rf pr-{N}/from FTP, keeping the server cleanRequired secrets
FTP_USERNAMEFTP_PASSWORD