Repository navigation
Conversation
`docs/typescript-sdk.md` linked `../sdk/typescript/README.md`, a Markdown file outside `docs/`, so `zensical build --strict` fails with "page does not exist" and the Docs workflow goes red. The failure is inherited from upstream 6d942c9 -- NandhaKishorM/laya's own Docs run fails on the identical link -- and the docs workflow's own comment says to use absolute GitHub URLs for files outside `docs/`, which every other such link already does. Verified: `zensical build --strict --clean` reports "No issues found" with zero `griffe:` lines; ruff, test_packaging, test_structured_docs, test_doc_tables and test_env_docs still pass.
Bruce-Yii
left a comment
There was a problem hiding this comment.
This and #742 are the same change, and as things stand they will conflict. One of the two needs to close.
Both branch from the same commit as main and touch only docs/typescript-sdk.md:67. I compared the resulting file at each head rather than eyeballing the diffs:
- resulting file size: 3444 bytes at your head, 3444 bytes at #742's
- whitespace-normalized content: identical
- the only difference is line wrapping
Same hunk, same base, different wrapping means whichever lands second gets a conflict rather than a clean no-op. Worth settling before either is merged rather than after.
The one thing that actually differs is line width. Longest line in the file:
| longest line | |
|---|---|
main |
104 |
| this PR | 104 (unchanged) |
| #742 | 122 |
So your rewrap introduces no line longer than main already has, while #742's one-line version pushes the file's worst line from 104 to 122 (+17%). That is the only substantive argument between them, and it cuts your way. Against it: #742 is the smaller diff (one line versus three) and already carries an approval, so it is the lower-friction merge. Genuinely close — the call is yours, but neither fact should need reconstructing to make it.
One clarification, since an absolute URL reads like a shortcut around the checker: it is what .github/workflows/docs.yml already prescribes. The build step is annotated "Use absolute GitHub URLs for files outside docs/ so links work when pages in docs/ are read on GitHub or on the site." And no relative path can work here — the site is built from docs/ only, and sdk/typescript/README.md sits outside it, so ../sdk/typescript/README.md has no target inside the build. Making it relative would mean moving or duplicating the SDK README into the docs tree, which is a far larger change than either of us is proposing. So this is a duplicate-ownership question, not a correctness one; both approaches are right.
Whichever you keep, closing the other unblocks every open PR currently sitting behind docs (strict build).
|
Closing in favour of #742, which was opened first (00:41Z against 07:18Z here) and already carries your approval. Normalising whitespace, the two heads are the same file, so there is nothing here worth a conflict. For the record, the line-width point is the weaker of the two: 122 characters is unremarkable across Thanks for comparing the two heads instead of the two diffs — that is what made this decidable rather than a coin toss. |
What
docs/typescript-sdk.mdlinks the TypeScript SDK README as../sdk/typescript/README.md. Thismakes it an absolute GitHub URL instead.
Why
sdk/typescript/README.mdis a Markdown file outsidedocs/, sozensical build --stricttries to resolve it as a page and fails:
That makes the Docs workflow red on
main(run 36606632973).The docs workflow already states the rule in its own comment -- "Use absolute GitHub URLs for
files outside docs/ so links work when pages in docs/ are read on GitHub or on the site" -- and
every other such link in
docs/follows it (BENCHMARKS.md,research/README.md, the notebook,examples/docker/request.json, and 35 more). This was the only exception.How it was verified
Checklist
main(branched from6d942c9; the diff is this one file)