Skip to content

Combine the manual and docs into one place - #24

Merged
The1UNeed merged 1 commit into
mainfrom
t3/combine-manual-docs
Nov 2, 2026
Merged

The1UNeed merged 1 commit into
mainfrom
t3/combine-manual-docs

Conversation

@The1UNeed

@The1UNeed The1UNeed commented Nov 2, 2026 •

Copy link
Copy Markdown
Owner

The site had two overlapping places to learn: the Manual and the Docs. They had their own nav links, and the editor modal only showed the Manual. Now everything lives in /docs.

  • Docs has two groups. Using PseudoEditor holds the existing studio guides. The new Pseudocode reference group holds the manual's content as six guides, in English and Chinese: writing an exam-style answer, the syntax reference, choosing a loop, worked programs, trace tables, and reading and writing files.
  • The editor's modal is now "Docs". It has a sidebar (a dropdown on phones) and an "Open in a new tab" link, and it remembers the last guide you read.
  • Old links still work. /manual, /app/manual and their /zh versions redirect permanently (308) to /docs. The Manual nav, footer and sitemap entries are gone.

Every docs example must compile, and the compiler rejected two claims in the old manual. They're corrected: LCASE/UCASE take a STRING, and ROUND returns a REAL. The reference pages use the slugs choosing-a-loop and reading-writing-files because loops and file-handling were already taken by lessons. Separately, a CSS reset fixes a bug that already affected public pages: every line of a code block was shaded by the inline-code style.

Proof: pnpm test (236 passed), pnpm typecheck and pnpm lint pass. curl against a dev server showed all three redirect paths landing on the right docs page. Playwright screenshots of the docs index, a reference page, the editor modal and the Chinese mobile view showed no page errors. A new test opens the editor's Docs modal, switches guides, and checks the choice survives closing and reopening.

Reviewed with sol-loop: 1 round with gpt-6.1-sol. Sol verdict: approved

Generated by claude-opus-5-5 using the Claude Code (T3 Code) harness.

🤖 Generated with Claude Code


Note

Low Risk
Large content and routing refactor with 308 redirects and nav changes; no auth, payments, or data-handling logic touched.

Overview
Manual and Docs are one surface now. The standalone /manual and /app/manual experiences (pages, ManualContent, nav/footer links) are removed. That material lives under /docs as a new Pseudocode reference unit alongside the existing Using PseudoEditor studio guides, in EN/ZH doc content. The docs index lists both units; routing uses isGuide() / guideUnitIds instead of hard-coding the pseudoeditor unit only.

Permanent redirects send /manual, /app/manual, and localized paths to /docs. Sitemap and metadata drop manual URLs; copy and SEO strings describe docs as studio + reference.

The editor “Manual” modal becomes “Docs”. A new DocsPanel loads guide content via guidesByLocale (lessons not bundled), with sidebar or mobile picker, “open in new tab”, and remembered last guide slug when reopening. Toolbar/settings labels switch to Docs.

Shared docs plumbing: CopyableCodeBlock moves under components/docs, uses i18n instead of manualText, and CSS renames manual-specific classes to generic .code-block (plus a prose fix so code lines aren’t double-shaded). The duplicate syntax guide is removed from pseudoeditor in favor of the reference pages.

Reviewed by Cursor Bugbot for commit f34e8ba. Bugbot is set up for automated code reviews on this repo. Configure here.

The manual's content becomes six guides in a new Pseudocode reference
group under /docs, in English and Chinese. /manual and /app/manual
redirect to /docs, the Manual nav and footer links go, and the editor's
modal now shows the docs guides and remembers the last one opened.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
pseudoeditor.dev Error Error Nov 2, 2026 6:59am UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-02T07:01:18.943229Z f34e8ba PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@cursor

cursor Bot commented Nov 2, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 19655156-0a10-4aec-8d7d-352acf2ec4b4)

@The1UNeed
The1UNeed merged commit bf461f3 into main Nov 2, 2026
6 of 7 checks passed

This branch had an error being deployed

1 failed deployment
Preview — f34e8ba2 Deployed Nov 2, 2026 by vercel[bot]
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.

1 participant