Skip to content

Phase 8: docs (CHANGELOG, ARCHITECTURE, CONTRIBUTING, TROUBLESHOOTING, CWS_REVIEW)#10

Merged
froggychips merged 1 commit into
mainfrom
review/phase-8-docs
May 19, 2026
Merged

Phase 8: docs (CHANGELOG, ARCHITECTURE, CONTRIBUTING, TROUBLESHOOTING, CWS_REVIEW)#10
froggychips merged 1 commit into
mainfrom
review/phase-8-docs

Conversation

@froggychips

Copy link
Copy Markdown
Owner

Summary

Финальный PR серии — документация. Раньше было только README + PRIVACY + SECURITY + пара marketing-doc'ов. Для CWS submission и внешних контрибьюторов нужен минимальный набор.

Что добавлено

Файл Назначение
CHANGELOG.md Keep a Changelog format. Unreleased секция агрегирует все правки из PR-1..PR-7. CWS reviewers читают changelog между версиями.
CONTRIBUTING.md Layout проекта, local dev (npm install / npm run lint / npm run package), code style, как добавлять провайдеры / DOM-стратегии / i18n. Bug-report шаблон требует dump tta_selector_health.
docs/ARCHITECTURE.md Диаграмма data-flow, описание компонентов (SW, content script, selectors, options, MCP), persistence layout по storage areas. Явно: "Что лежит off-disk" — ничего, no telemetry.
docs/TROUBLESHOOTING.md Pathways: X сломал DOM, ключ битый, SW засыпает, rate-limit, MCP offline. Каждая секция → конкретные DevTools команды + storage ключи для диагностики.
docs/CWS_REVIEW.md Внутренний чеклист submission: manifest hygiene, code checks, store-listing assets, permission justifications таблицей (CWS dev console спрашивает в этой форме).
README.md Секция Releasing переписана с ручного zip на npm run package. Ссылки на CONTRIBUTING / ARCHITECTURE / TROUBLESHOOTING.

Что НЕ добавлено

  • Screenshot 1280×800 для CWS listing — без живого расширения на x.com генерировать не получается. В docs/CWS_REVIEW.md это явно отмечено как открытый пункт. Сделать вручную перед submission.

Test plan

  • Открыть каждый doc — markdown рендерится без сломанных ссылок
  • Линки в README ведут на правильные файлы
  • docs/CWS_REVIEW.md чеклист проходим end-to-end на текущем состоянии main

🤖 Generated with Claude Code

…IEW (Phase 8 of code review)

Документации почти не было: README + PRIVACY + SECURITY и пара docs/LAUNCH/RECORDING.md.
Для CWS submission и внешних контрибьюторов нужен минимальный набор.

- CHANGELOG.md (Keep a Changelog format): Unreleased секция содержит
  всё что прошло через PR-1..PR-7 — security/security/i18n/providers/
  selectors/SW-keepalive/MCP-cache/tooling. CWS reviewers смотрят
  changelog между версиями.
- CONTRIBUTING.md: layout проекта, local dev, code style, как
  добавлять провайдеры / DOM-стратегии / i18n-строки, commit/PR
  conventions, bug-report format с обязательным dump tta_selector_health.
- docs/ARCHITECTURE.md: диаграмма data-flow content_script <-> SW <->
  AI providers / MCP, описание компонентов, persistence layout
  (storage.sync / .local / .session / in-memory). "Что лежит off-disk"
  явно: ничего, no telemetry.
- docs/TROUBLESHOOTING.md: pathways когда X сломался, ключ битый, SW
  засыпает, rate-limit, MCP offline. Каждая секция указывает на
  конкретные DevTools-команды и storage-ключи для диагностики.
- docs/CWS_REVIEW.md: внутренний чеклист submission — manifest
  hygiene, code checks, store-listing assets, permission justifications
  таблицей (для соответствующего поля в dev console).
- README.md: секция Releasing переписана с ручного zip на
  npm run package. Ссылки на CONTRIBUTING/ARCHITECTURE/TROUBLESHOOTING.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@froggychips froggychips merged commit 5369b40 into main May 19, 2026
@froggychips froggychips deleted the review/phase-8-docs branch May 19, 2026 08:25

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 13f38beb44

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/TROUBLESHOOTING.md

- Options → Advanced → For developers → MCP Gateway → **Test**.
- Confirm `mcpUrl` matches what your local MCP server is listening on.
- TweAI 1.8.1+ moved localhost into `optional_host_permissions`. The first time you set an MCP URL, Chrome will prompt you to grant `http://127.0.0.1/*` permission — accept it. If you didn't, the request will fail without a clear error.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Remove the nonexistent MCP permission prompt

When MCP is enabled, this troubleshooting step says Chrome will prompt for the optional localhost host permission, but I checked the repo for chrome.permissions and there is no code path that calls chrome.permissions.request; mcpFetch only reads prefs.mcpUrl and fetches it. With localhost only in optional_host_permissions, users will not see the described prompt, so enabling MCP can keep failing while this guide points them at an action they cannot take.

Useful? React with 👍 / 👎.

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