Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Evaluate the navigation diagrams as permanent documentation

Đang mở
  • Có gì không ổn?
#261 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách so sánh sáu artifact trong docs/navigation với main và commit của branch được trích dẫn 0ab3de6, sau đó đọc src/hooks/usePhraseWindowHalf.ts và các tham chiếu trong README. Công việc được xem là hoàn tất khi mỗi sơ đồ có quyết định chấp nhận hoặc từ chối rõ ràng, có vị trí lâu dài được ghi lại nếu được chấp nhận, và các khẳng định hiện đang mô tả hành vi chỉ có trong branch được con người kiểm chứng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation 🟪Idea

Six diagrams of the book/segment/verse/phrase/token navigation surface were produced while reviewing #235. This issue is to decide which, if any, become permanent docs. If any, where/how should they live in the docs?

The navigation surface spans several independent axes:

  • structure,
  • coordinate spaces,
  • entry points,
  • per-scenario causality,
  • concurrent state,
  • frame-level timing.

No single diagram covers it, so each of the six takes one axis.

The gain: onboarding and change-safety: much of this behavior currently exists only as reasoning inside long doc comments.
The cost: staleness, since each diagram cites specific functions and constants and nothing will flag them when those move. Also, 4 of the diagrams are SVGs, which aren't diffable when updated.

Developed from branch perf/continuous-view-responsiveness @ 0ab3de6 (the open continuous-view perf PR, unmerged). They describe that branch, not main: src/hooks/usePhraseWindowHalf.ts, the holdCentered loop, and the deferred mid-glide re-centre are all branch-only.

Authored by Claude Opus 5 (1M context) — model claude-opus-5[1m] — read from the source on that branch. Every claim traces to a file listed in the README, but none of it has been independently verified by a human.

Temporarily housed at docs/navigation-diagrams, commit 7ab4df0, branched off main.

--

The six, to accept or reject individually
  1. 01-structure-bands.svg — To-scale band diagram of one stretch of LUK, marking the four places where verse, segment, token, phrase and window boundaries fail to line up.
  2. 02-coordinate-spaces.svg — The eight addresses one text position has, and which of the sixteen conversions between them are lossy, partial, or one-to-many.
  3. 03-entry-point-matrix.md — Sixteen ways navigation can start, against what each subsystem does about each, plus the asymmetries the empty cells expose.
  4. 04-scenarios.md — Six mermaid sequence diagrams: external nav, cross-book jump, arrow step, list click, boundary edit mid-glide, and mode toggle.
  5. 05-concurrent-clocks.svg — Harel statechart of the five state machines that run simultaneously, and the six couplings that are the only channels between them.
  6. 06-timing-waterfall.svg — Two navigations plotted against frames and the real constants, showing why the settle is event-driven rather than timed.
Ngôn ngữ chính
TypeScript
Star
2
Fork
0
Merge trung bình
2 ngày 3 giờ
Pull request đã merge (30 ngày)
46

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của sillsdev/interlinearizer-extension

Tất cả issue của sillsdev/interlinearizer-extension

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.