Skip to content

fix(docs): add DeepSeek Harness to installation table - #231

Merged
tt-a1i merged 3 commits into
tt-a1i:mainfrom
RedHeartSecretMan:codex/fix-readme-table-boundary
Sep 1, 2026
Merged

tt-a1i merged 3 commits into
tt-a1i:mainfrom
RedHeartSecretMan:codex/fix-readme-table-boundary

Conversation

@RedHeartSecretMan

Copy link
Copy Markdown
Contributor

Problem and value

The DeepSeek Harness installation note was placed immediately after the Installation options table and contained an unescaped Node version disjunction (||). GitHub Flavored Markdown treated the line as an implicit table row, split the inline code across cells, and rendered a malformed narrow cell with a literal backtick.

DeepSeek Harness is an installation surface, so this change represents it as an explicit three-cell row instead of moving it into a long paragraph outside the table.

Scope

  • What changed:
    • Added an explicit DeepSeek Harness row to the installation tables in README.md, README_EN.md, and README_ZH.md.
    • Split the existing install/invoke/remove instructions and compatibility boundary across the method and capability cells.
    • Escaped the Node version pipes in Markdown so GitHub renders ^22.19.0 || >=24.0.0 inside one code span.
    • Added a regression test that requires exactly three table cells, escaped version pipes, and a table boundary after the row.
    • Kept the DSH documentation contract semantic by normalizing Markdown pipe escapes before checking the version text.
  • What deliberately did not change:
    • No renderer, validator, CLI, package, release identity, or generated artifact changed.
    • No DeepSeek Harness runtime or compatibility behavior changed.
  • No unrelated changes: confirmed.

Stability impact

  • Compatibility and migration risk: documentation-only; no migration is required.
  • Renderer, validator, package, or generated-artifact risk: none. Runtime and packaged bytes are unchanged.
  • Failure behavior and rollback path: revert this commit to restore the prior README source and tests.

Tests run

  • cd archify && npm ci — 10 packages installed from the lockfile; 0 vulnerabilities.
  • cd archify && npm test — 1,014 tests; 983 passed, 0 failed, 31 environment-gated tests skipped; golden renders, schemas, generated validators, brand marks, and release identity all passed.
  • node --test archify/test/readme-showcase.test.mjs — 7/7 passed.
  • node --test integrations/deepseek-harness/test/docs-contract.test.mjs — 4/4 passed.
  • node scripts/check-release-identity.mjs — release identity ok: 2.16.0.
  • git diff HEAD^ HEAD --check — passed.

Visual evidence

Generated artifacts

None. This changes README Markdown and documentation tests only; Gallery pages, guides, README proof media, and archify.zip have no changed authoritative inputs and remain fresh.

Checklist

  • I used a minimal focused change and preserved existing typed JSON behavior unless the issue requires a contract change.
  • I ran the relevant targeted tests and npm test in archify/.
  • I added or updated a regression test for behavioral changes.
  • I checked generated artifacts and package freshness when their sources changed.
  • I removed secrets, private repository content, and customer data from fixtures and screenshots.

@tt-a1i tt-a1i left a comment •

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial maintainer review before the final main synchronization.

Problem: the unescaped double pipe in the DeepSeek Harness Node version constraint was parsed by GitHub Flavored Markdown as table separators, breaking the README layout.

Approach: represent the integration as an explicit three-cell table row, escape the version pipes, and add README and DeepSeek Harness documentation-contract regression coverage.

Impact: documentation and documentation tests only; no runtime, package, or generated artifact changes.

The targeted tests passed 10/10 and the full required CI suite passed. This review was superseded by the final exact-head re-review after the subsequent main synchronization.

@tt-a1i tt-a1i left a comment •

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maintainer re-review after synchronizing with the latest main.

Problem, approach, and impact remain unchanged: fix the malformed DeepSeek Harness README table row with an explicit three-cell row and regression tests. The change is limited to documentation and documentation tests.

Verified exact head 5772283 against main 3411a18. git diff --check passed; the targeted tests passed 10/10; all required CI checks, three-platform package smoke tests, ZIP freshness, and WebM/browser artifact checks passed. No blocking findings.

@tt-a1i
tt-a1i merged commit 199360c into tt-a1i:main Sep 1, 2026
11 checks passed
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