Skip to content

Redesign the docs to match the site and rewrite the copy - #7

Merged
boomzero merged 3 commits into
masterfrom
redesign
Oct 5, 2026
Merged

boomzero merged 3 commits into
masterfrom
redesign

Conversation

@boomzero

@boomzero boomzero commented Oct 5, 2026 •

Copy link
Copy Markdown
Member

Why

Follow-up to XMOJ-Script-dev/XMOJ-Script#1043 (PythonSmall-Q: 「你要不顺手docs也改一下吧」). The docs didn't match the new site. They were wordy, and several things in them were wrong:

  • Dead links: xmoj-bbs.me / api.xmoj-bbs.me, and the old user agreement mentioned ads and web.xmoj-bbs.tech.
  • Install steps: Chrome 138+ was told to turn on both Developer mode and 允许用户脚本, which mixed up the old and new steps. Edge 138+ wasn't separated from older versions.
  • Rating colours: listed as red ≥500. The code is > 500, so exactly 500 is yellow.
  • Badges: said to be edited on modifypage.php with options to pick or reorder badges. The editor is on modify_user_info.php and only edits text and colours.
  • Auto-submit: claimed a ~90% chance of a 「疑似提交当年代码」 badge. That badge was part of the ACM rankings, which were removed in 201c158, so nothing adds it any more. It also said the run can't be stopped, but leaving the page stops it.
  • Badge funding: said sponsorship pays for the servers.

What

  • Theme: black-and-white, matching xmoj-script.uk and the script's MonochromeUI. It uses the same tokens, fonts (Playfair Display / Source Serif 4 / JetBrains Mono via fonts.loli.net), square corners and no shadows, with light and dark modes.
  • Copy: every page is rewritten in short, plain Chinese. Feature claims were checked against XMOJ.user.js (settings list, rating formula and thresholds, auto-submit loop, image upload, badge editor).
  • Install guide: separate steps for Chrome 138+, Edge 138+ and Chrome/Edge ≤137, plus Firefox/Safari. The inline-styled buttons are replaced by theme classes.
  • Feature overview: rebuilt from the real 插件设置 list, in the same order.
  • Image upload: warns that images open for anyone with the link and can't be self-deleted, matching the site's privacy page.
  • 短消息在线看: warns that PHPSESSID is equivalent to a password.
  • legal/eula.md: now a short page linking to the site's 使用条款 / 隐私说明 / 未成年人保护. The URL is kept so old links still work.
  • Hero image: real screenshots of the current script, in light and dark. The old demo.png (old UI) is removed.
  • Nav and footer: link to the site and the legal pages.
  • PR previews: the FTP preview workflows (preview.yml, preview-cleanup.yml) are removed. The InfinityFree login has failed with 530 since at least August. Previews will come from Cloudflare Pages' GitHub integration, which comments a preview link on each PR, once the project is connected in the dashboard. Production is unchanged: build.yml still publishes master to GitHub Pages.

Checks

  • npm run docs:build passes.
  • Every page loads at 1280px and 390px, in light and dark, with no console errors, no failed local requests, no horizontal overflow, and no stray ** or broken characters in the rendered text.

🤖 Generated with Claude Code

https://claude.ai/code/session_017dqWu3YgeVRGwBt5pXDq4A

- Black-and-white theme matching xmoj-script.uk and the script's MonochromeUI
- Every page rewritten in short, plain Chinese and checked against XMOJ.user.js
- Install guide covers the Chrome/Edge 138+ 允许用户脚本 toggle
- Dead xmoj-bbs.me links replaced; old user agreement points to the site's terms/privacy
- Hero uses real screenshots of the current script UI

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017dqWu3YgeVRGwBt5pXDq4A
boomzero and others added 2 commits October 5, 2026 20:05
The InfinityFree FTP login has failed since at least August (530).
Cloudflare Pages' GitHub integration builds each PR and comments the
preview link, so no workflow or secrets are needed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017dqWu3YgeVRGwBt5pXDq4A
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017dqWu3YgeVRGwBt5pXDq4A
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0361099
Status: ✅  Deploy successful!
Preview URL: https://e61d8dc7.docs-42b.pages.dev
Branch Preview URL: https://redesign.docs-42b.pages.dev

View logs

@boomzero
boomzero merged commit b20add3 into master Oct 5, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant