Skip to content

docs: sync Markmap, TOC clearance, FileTree comments, and table wide policy - #11

Open
imbajin wants to merge 1 commit into
pgsty:mainfrom
imbajin:fix/readability-design-contracts
Open

imbajin wants to merge 1 commit into
pgsty:mainfrom
imbajin:fix/readability-design-contracts

Conversation

@imbajin

@imbajin imbajin commented Oct 14, 2026 •

Copy link
Copy Markdown

Synchronize canonical EN/ZH documentation with upstream theme implementations and contracts:

Summary of Changes

  1. Markmap Appearance & Fixed TOC Clearance (content/docs/design/components*, content/docs/design/shell*):

    • Documented Markmap text color inheriting --bs-body-color on screen via --markmap-text-color, print dark-ink retention, and override scoping.
    • Documented fixed TOC rail sharing --td-shell-footer-offset for dynamic footer clearance, fat footer resize integration, and sidebar_enabled: false support.
    • Addressed upstream review comments: pgsty/oink#48 comment and pgsty/oink#50 comment.
  2. FileTree Comment Wrapping (content/docs/design/components*, content/docs/components/filetree*):

    • Synchronized with pgsty/oink#52.
    • Documented automatic comment text wrapping (overflow-wrap: anywhere) and dynamic row height expansion, eliminating long-comment truncation and reliance on hover.
    • Corrected examples and descriptions in both languages; retained single-line ellipsis truncation for filenames.
  3. Table Width Policy & .td-table--wide (content/docs/design/components*, content/docs/components/table*):

    • Synchronized with pgsty/oink#54.
    • Documented ordinary tables defaulting to reading-column fit (width: auto) and technical tables opting into wider intrinsic sizing (width: max-content) with .td-table--wide.
    • Clarified distinction between .td-table--wide (inner table sizing) and .full-width (outer viewport wrapper).
    • Documented cell token preservation (overflow-wrap: break-word), soft body-cell cap (max-width: 40ch), and static output boundaries (td-table-scroll--static).
  4. Consistency & Validation:

    • Standard Chinese line-wrapping rhythm and bilingual heading/anchor parity maintained across all pairs.
    • Explicitly distinguished published v1.2.0 baseline from unreleased post-v1.2.0 capabilities.
    • Scoped Markdown style and translation checks passed.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 14, 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-10-14T08:53:02.088735Z 4b28987 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.

@imbajin imbajin closed this Oct 14, 2026
@imbajin imbajin reopened this Oct 14, 2026
@imbajin
imbajin force-pushed the fix/readability-design-contracts branch 2 times, most recently from 869b72b to ea6354e Compare October 14, 2026 17:06
…policy

- Document screen/print Markmap text contract and fixed TOC footer clearance
- Document FileTree comment wrapping without clipping or requiring hover (pgsty/oink#52)
- Document table width policy, .td-table--wide explicit marker, and boundaries (pgsty/oink#54)
- Maintain bilingual parity, line-wrapping conventions, and heading anchors across EN/ZH
- Distinguish published v1.2.0 behavior from post-v1.2.0 unreleased capabilities
@imbajin
imbajin force-pushed the fix/readability-design-contracts branch from ea6354e to ecada9f Compare October 14, 2026 17:34
@imbajin imbajin changed the title docs(design): document Markmap appearance and fixed TOC footer clearance docs: sync Markmap, TOC clearance, FileTree comments, and table wide policy Oct 14, 2026

This branch has not been deployed

No deployments
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