Skip to content

docs: formal README in both languages, with stale claims corrected - #243

Merged
SuruchBoss merged 2 commits into
mainfrom
claude/new-session-m6mehm
Oct 5, 2026
Merged

SuruchBoss merged 2 commits into
mainfrom
claude/new-session-m6mehm

Conversation

@SuruchBoss

Copy link
Copy Markdown
Owner

What this changes

The owner asked for the README to read more formally, with the landing page updated if anything on it had changed. Documentation only, apart from three link targets; no behaviour changes.

Headings without emoji, in both READMEs. All 76 headings lose their leading emoji. The following were updated to the new anchors:

  • every internal link in both READMEs;
  • the links into the READMEs from /guide, the landing page, th.ts/en.ts and docs/payneat-erp*.md;
  • the two markers check:readme uses to find the Features section.

A formal opening, in both languages. The opening now runs in this order:

  • a one-line description and a row of links (app, data guide, issues, security policy);
  • a dated project status saying the pre-pause set closed on 5 October 2026;
  • Overview, then Key capabilities, a list with each item linked to its section;
  • Data handling, a table of every case in which data leaves the device: AI with and without a key, live data from the browser, the usage counter, crash reports, cloud save.

The Thai README keeps an English summary, now formal.

Moves and renames.

  • "What 2017 passing tests could not catch" moves from the top to the Testing section as Limits of automated testing. It is rewritten in the third person, with the same content.
  • "Why this project" becomes Project goals.
  • The Thai "วิธีรัน" becomes "การติดตั้งและใช้งาน".
  • The "Try it in 60 seconds" text and the remaining first-person sentences are rewritten in a neutral voice. That includes the author's sign-off.

Stale claims corrected

Where Said Is
Getting started, the /app row opens on a sample sheet opens on a blank sheet, with Try it with sample data on the green bar
Live data, Limits; roadmap no follow-along sample, the three sample sources gone with nothing in their place the three sample APIs (/api/sample/*) have been in the panel since 28 Sep; roadmap item ticked
Roadmap Ctrl+B / Ctrl+I / Ctrl+U missing they toggle bold, italic and underline (SpreadsheetGrid.tsx), as the Features section already said
Landing "read every limitation", /guide (Thai), FAQ link (Thai) #-สิ่งที่จะทำต่อ, #-ข้อมูลสด…, #-นำเข้าไฟล์… the new anchors; the old ones would land at the top of the README

The landing page's visible text was checked against today's main and needed no change. Its sample-API sentence is correct, and its counts are verified by check:readme. So no screenshot was retaken: the only landing and guide changes are hrefs.

How it was verified

  • npm run verify (all ten gates): all green on b6f69ef.
Gate Result
lint · check:readme · check:screens pass
check:deps every advisory fixed or accounted for
test 2028 passed (2017 by the README's static count)
check:mutants 32/32 killed
build · check:bundle 3804/4200 KB, largest chunk 934/1300 KB
check:a11y 121 checks passed
check:e2e 60 flows passed
  • check:readme: every internal link in both READMEs resolves, and the Features section is found under its new heading. It has 55 sections in both languages, each linked from the contents.
  • Searched for leftovers: no README…#- anchor remains in src/, docs/ or scripts/; no emoji remains in a heading; no first-person sentence remains in either README's own voice. Quoted user phrases such as "I want to total…" stay.

For PO

  • The body of the feature sections was not rewritten line by line. Those sections were already technical, third-person prose. What changed there is the headings, links, first-person sentences and the corrections above.
  • Links from outside the repository to old anchors (issues, PRs) now open at the top of the README instead of the section.
  • The landing page's "read every limitation" link goes to the Thai README in both languages, as before. I left it as it is, since changing it is a behaviour change, not a wording one.

The branch

This is the session's branch claude/new-session-m6mehm, started from main 448a5b2.

🤖 Generated with Claude Code

https://claude.ai/code/session_013pmWZsbmugfpqtYazrzfjj


Generated by Claude Code

claude added 2 commits October 5, 2026 05:55
Headings in both READMEs lose their leading emoji. Every internal link,
the links into the READMEs from the guide page, the English strings and
the PaynEat ERP notes follow the new anchors, and check:readme locates
the Features section by its new heading.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013pmWZsbmugfpqtYazrzfjj
…le claims

Both READMEs open with an overview, a list of key capabilities and a
table of every case in which data leaves the device, followed by a
dated project status. The account of what the test suite could not
catch moves to the Testing section as "Limits of automated testing",
and "Why this project" becomes "Project goals". First-person
sentences are rewritten in a neutral voice.

Corrections found along the way:
- /app opens on a blank sheet, not on the sample.
- The three sample APIs exist; the Limits list and the roadmap still
  said the sample sources were gone with nothing in their place.
- Ctrl+B / Ctrl+I / Ctrl+U work; the roadmap still listed them as missing.
- The landing page's two links into the README and the guide page's
  Thai link pointed at anchors that no longer exist.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013pmWZsbmugfpqtYazrzfjj
@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
excel-to-go Ready Ready Preview Oct 5, 2026 6:22am UTC

@SuruchBoss
SuruchBoss merged commit f2ecbf6 into main Oct 5, 2026
18 checks passed

Copy link
Copy Markdown
Owner Author

PO review: merged at b6f69ef (merge commit f2ecbf6). The owner asked for this README rewrite directly.

Gates

  • npm run verify on b6f69ef, run locally: all ten gates green. 2028 tests passed, mutants 32/32, a11y 121 checks, e2e 60 flows.
  • CI: 17 checks green, CodeQL included.

Links into the READMEs from outside them

  • Every link from src/ and docs/ into either README resolves to a real heading. That is 5 links, checked against GitHub-style slugs of all 118 headings per language.
  • On a production build, these links read as follows:
    • Landing (TH): #สิ่งที่จะทำต่อ and #นำเข้าไฟล์-excel-ที่มีอยู่แล้ว.
    • Landing (EN): README.en.md#import-an-existing-excel-file.
    • Guide (TH): #ข้อมูลสดจาก-api--csv-prototype.
    • Guide (EN): README.en.md#live-data-from-an-api--csv-prototype.
    • No page errors.

Content

Small and pre-existing, not filed: the English landing's "what's next" link goes to the Thai README (#สิ่งที่จะทำต่อ). Its href was hard-coded to the Thai README before this PR too.


Generated by Claude Code

This branch was successfully deployed

1 active deployment
Preview — b6f69ef9 Deployed Oct 5, 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.

2 participants