Skip to content

Fix docs-consistency test assumptions for current README set #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

Fix docs-consistency test assumptions for current README set #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c61aaeb
Initial plan
Copilot Jul 24, 2026
284153f
Fix docs consistency test for current README files
Copilot Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions tests/docs-consistency.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ function markdownLinks(markdown: string): string[] {
}

describe("documentation consistency", () => {
const publicDocs = [resolve(root, "README.md"), resolve(root, "README-EN.md"), ...markdownFiles(docsRoot)];
const publicDocs = [resolve(root, "README.md"), resolve(root, "README-zh.md"), ...markdownFiles(docsRoot)];

it("package entry points target compiled artifacts", () => {
const pkg = JSON.parse(readFileSync(resolve(root, "package.json"), "utf8"));
Expand Down Expand Up @@ -101,7 +101,7 @@ describe("documentation consistency", () => {
it("does not expose internal Pi host or superseded completion and renderer conventions", () => {
const currentGuides = [
resolve(root, "README.md"),
resolve(root, "README-EN.md"),
resolve(root, "README-zh.md"),
resolve(docsRoot, "getting-started.md"),
...markdownFiles(resolve(docsRoot, "guides")),
...markdownFiles(resolve(docsRoot, "reference")),
Expand All @@ -113,7 +113,7 @@ describe("documentation consistency", () => {

it("does not claim that debug logging is enabled by default", () => {
const readme = readFileSync(resolve(root, "README.md"), "utf8");
expect(readme).toContain("默认不会写调试日志文件");
expect(readme).toContain("Debug log files are not written by default.");
expect(readme).toContain("debug: true");
});
});
Loading