Add Reading settings and comprehensive documentation - #101
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Reduce Motion is not fully honored for the new reading-position preview transition path (implicit scrollOffset animation still occurs when duration is set to 0).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a dedicated Reading settings pane and publishes a comprehensive /docs/ guide, while tightening Director live-edit behavior and polishing paragraph-break rendering and notch UI spacing.
Changes:
- Introduces a new Reading settings tab (position, paragraph dividers, last-spoken words, keep-awake) and improves the settings notch preview behavior/layout.
- Preserves Director paragraph breaks/locked read boundary during live edits and clamps preserved read progress more safely.
- Publishes/links a full responsive documentation site and updates README Director authentication + protocol details.
File summaries
| File | Description |
|---|---|
| Textream/Textream/TextreamService.swift | Clamps preserved read prefix to recognized + director-locked boundary when updating Director text. |
| Textream/Textream/SettingsView.swift | Adds Reading tab, refines notch preview sample/animation identity, tightens port bounds, expands Reset All coverage. |
| Textream/Textream/NotchSettings.swift | Validates persisted server ports to 1024…65534 (HTTP) on load. |
| Textream/Textream/NotchOverlayController.swift | Improves compact notch control spacing and adds a fade mask for breathing room. |
| Textream/Textream/MarqueeTextView.swift | Adds paragraph divider dots/spacing and preview-only reading-position transition support. |
| Textream/Textream/DirectorServer.swift | Normalizes Director text to preserve paragraph breaks and locks the read prefix during live editing. |
| README.md | Updates Director connection/auth handshake docs + adds cueColor to state schema and client example. |
| docs/support.html | Adds Docs link in nav/footer. |
| docs/privacy.html | Adds Docs link; improves semantic markup for summary section. |
| docs/index.html | Adds Docs link to homepage nav and improves responsive/accessibility styling. |
| docs/docs/index.html | Adds new full documentation page content for /docs/. |
Review details
- Files reviewed: 11/11 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+266
to
+283
| if let transitionDuration = readingPositionTransitionDuration { | ||
| captureStableLineMetrics(from: wordYPositions) | ||
| readingPositionAnimationGeneration &+= 1 | ||
| let generation = readingPositionAnimationGeneration | ||
| isAnimatingReadingPositionChange = transitionDuration > 0 | ||
|
|
||
| if let animation = readingPositionTransitionAnimation { | ||
| withAnimation(animation) { | ||
| recalculateTracking(containerHeight: containerHeight) | ||
| } | ||
| DispatchQueue.main.asyncAfter(deadline: .now() + transitionDuration) { | ||
| guard generation == readingPositionAnimationGeneration else { return } | ||
| isAnimatingReadingPositionChange = false | ||
| } | ||
| } else { | ||
| recalculateTracking(containerHeight: containerHeight) | ||
| } | ||
| } else { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/docs/, add the Docs link to the homepage, and document URL-scheme and authenticated Director API automationValidation
Textream, arm64, signing disabled)html-validateacross the homepage, docs, privacy, and support pages/,/docs/,/support.html, and/privacy.htmlgit diff --checkThere is no macOS test target in the project, so the native validation is build- and runtime-smoke-based.