Skip to content

docs: keep setup guidance independent of interface languages - #178

Merged
YusukeIt0 merged 4 commits into
mainfrom
docs/language-neutral-guidance
Oct 24, 2026
Merged

YusukeIt0 merged 4 commits into
mainfrom
docs/language-neutral-guidance

Conversation

@YusukeIt0

Copy link
Copy Markdown
Owner

README voice-activation instructions mixed interface language support with a fixed pronunciation list and old feature-introduction versions. Describe the current cue → recording prompt → speech flow without a language list or historical version qualifiers, and state that the wake phrase is independent of interface language. Detailed acoustic limitations and attributed validation history remain in the wake guide.

Keep the supported-interface-language list in README only. Setup and localization guides link to it, and the add-language checklist requires updating that single list instead of duplicating languages or per-language versions in setup prose. No acoustic capability is added or claimed.

Validation: git diff --check; inspected all README language/pronunciation/version references and duplicate language lists in setup/localization guides; checked relative links and target headings. Documentation only: no runtime, permission, privacy, dependency or release artifact changes, so no device retest is needed. Follow-up to #177 and completed #15.

@dotsweeper

dotsweeper Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

dotsweeper review · Complete

Reviewed PR head: 70a6d25b0458 · Run

This PR only changes documentation, in README.md, docs/setup.md and docs/localization.md. In the README's Hey dot step, it removes the minimum Even app versions (0.3.1/0.3.4), the "English or Japanese pronunciation" wording and the literal "Go ahead" label. It adds that the wake phrase is independent of the interface language. The language lists in setup.md and localization.md are replaced with links to the README's "Interface languages" list (README.md:81, under the "Make it yours" heading, so #make-it-yours resolves). The localization checklist now says to update that one list.

I checked the links: ../README.md#make-it-yours and #application-language (setup.md:108) both point to existing headings. A search of the main checkout found exactly three duplicate language lists, at setup.md:17, setup.md:111 and localization.md:4, and the PR replaces all three. The details taken out of the README are still in docs/wake-word.md, which README.md:77 links to: the Japanese pronunciation (ヘイ、ドット), the "Go ahead" prompt and the language independence. The minimum versions dropped from the README are well below the current app version (package.json/app.json are at 0.3.33), so the condition no longer matters for the Even Hub build users install now. I found no defects introduced by this change. There is no runtime, permission, privacy, credential or release-artifact change, so no device test is needed.

Requirements and verification evidence

Scope: unknown. Physical verification: not-required.

  • Evidence gap: No acceptance record from a configured maintainer exists for this PR, so its documentation scope (README as the only list of interface languages, no minimum versions or pronunciation details in the README) has not been formally accepted.

Automatic-merge evidence: No acceptance record from a configured maintainer.

Device/runtime records are attributed observations. This reviewer did not operate a device or run tests.

Next steps

Before merge, a configured maintainer needs to add an acceptance record. The record should confirm the intended scope: the README is the only place that lists interface languages, and the Hey dot step leaves out minimum versions and pronunciation details, pointing to docs/wake-word.md instead. CI for head 70a6d25 is still in progress. A separate job checks CI completion, so this review makes no claim about it.

Scope and limitations

This review is static inspection only. I ran no tests or link checker, did not render the Markdown, and did no device testing. I checked anchors by matching heading text against GitHub's slug rules. My check for duplicate language lists covered Markdown files in the checked-out main tree only. I did not check Even Hub listing text or in-app strings.

Advisory static review; no tests or physical-device checks were run. Maintainers decide adoption and merging.

For another review, the author or a maintainer can comment /dotlink review.

@YusukeIt0
YusukeIt0 merged commit 591a875 into main Oct 24, 2026
8 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.

1 participant