Skip to content

docs: landing accuracy fixes + README copyright (license/version/watcher/tests/anchors)#46

Merged
sgwannabe merged 3 commits into
mainfrom
docs/landing-accuracy-fixes
May 30, 2026
Merged

docs: landing accuracy fixes + README copyright (license/version/watcher/tests/anchors)#46
sgwannabe merged 3 commits into
mainfrom
docs/landing-accuracy-fixes

Conversation

@sgwannabe
Copy link
Copy Markdown
Contributor

@sgwannabe sgwannabe commented May 30, 2026

Accuracy pass on index.html (landing served at memex.quest), found via a 3-dimension audit against the code + canonical facts. Content-only; merging redeploys via the deploy-landing workflow.

Fixed

  • License (blocking): footer github · MITgithub · Apache-2.0 (LICENSE is Apache-2.0).
  • Version (blocking): §06 Run desktop v0.1.0 releasev0.1.2 release, noted signed & notarized + added brew install --cask two-weeks-team/tap/memex.
  • Watcher (blocking): mislabeled notify watcher in 3 spots — code polls (~60 s) and explicitly does not use notify/FSEvents (watcher.rs:15, lib.rs:80 unwrap_or(60)) → ~60 s poll. Surfaces 12 s poller~60 s poller.
  • Tests (high): §06 docker 283 lib + 5 integration294 unit + integration + E2E.
  • Self-contradiction (med): §02 arch detail 27 unit vs JS 31 unit → unified to 31 (companion.rs has 31 #[test]).
  • Dead link (high): footer /blob/main/CHANGELOG.md (404 — no such file) → /releases.
  • Stale anchor (high): footer memex install all#install (gone in the rewritten README) → #quick-start.

Verified-correct, left alone

memex_sessions_v3, fastembed 5.15, MCP "12 tools (11 read + 1 write)", "8 vector slots", Qdrant 1.18/Docker 1.18.1, og/twitter meta tags (present on main).

Intentionally left (illustrative, not shipped-behavior claims)

Animated topology galaxy stat chips (stylized ~75-node scene) and Companion/Wrapped demo latency/corpus figures. Can align to the 80-session corpus on request.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • 설정 및 문서 업데이트
    • v0.1.2로 버전 업데이트
    • 모니터링 폴링 주기 정보 수정
    • 테스트 항목 설명 개선
    • 빠른 시작 및 참고 자료 링크 최적화

Review Change Stack

Audited index.html against the code + canonical facts and fixed every confirmed
staleness:

- Footer license: "github · MIT" → "github · Apache-2.0" (LICENSE is Apache-2.0).
- §06 Run desktop: "v0.1.0 release" → "v0.1.2 release", noted signed & notarized
  + added the Homebrew one-liner.
- Watcher mischaracterized as "notify" in 3 places (it polls, ~60 s — watcher.rs
  explicitly does NOT use notify/FSEvents) → "~60 s poll". Also the Surfaces
  "12 s poller" → "~60 s poller".
- §06 Run docker test count "283 lib + 5 integration" → "294 unit + integration
  + E2E".
- §02 arch detail: "27 unit" → "31 unit" (companion.rs has 31 #[test]; matches the
  JS panel which already said 31).
- Footer dead link: /blob/main/CHANGELOG.md (no such file) → /releases.
- Footer "memex install all" anchor #install (gone in the rewritten README) →
  #quick-start.

Left as intentional illustration (not shipped-behavior claims): the animated
topology galaxy stat chips and the Companion/Wrapped demo latency/corpus figures.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 30, 2026

Warning

Review limit reached

@sgwannabe, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 46 minutes and 55 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1e644052-6b00-4339-bb85-b45720a32e2f

📥 Commits

Reviewing files that changed from the base of the PR and between eb5e66e and be4fafc.

📒 Files selected for processing (2)
  • README.md
  • index.html

Walkthrough

index.html에서 시스템 폴링 메커니즘, 릴리즈 버전, 테스트 통계, 푸터 네비게이션을 업데이트하여 UI 표시 문구와 스크립트 데이터를 동기화했습니다.

Changes

문서 및 메타데이터 동기화

Layer / File(s) Summary
폴링 및 모니터링 메커니즘 설명 업데이트
index.html
아키텍처 상세 패널, 실행(Desktop) 가이드, 스크립트 ARCH_DATA, Surfaces 섹션에서 Watcher 감시 방식을 notify 기반에서 ~60 s poll · content-hash dedup으로 변경하고 폴링 주기를 12 s에서 ~60 s로 일관되게 업데이트, 단위 테스트 수를 31 unit으로 갱신했습니다.
릴리즈 버전 및 테스트 통계 업데이트
index.html
실행(Desktop) 안내의 릴리즈 버전을 v0.1.0에서 v0.1.2로 변경하고, 실행(Docker) 안내의 테스트 항목 요약을 294 unit + integration + E2E로 갱신했습니다.
푸터 네비게이션 및 라이선싱 정보 업데이트
index.html
푸터 "Start" 섹션의 빠른 시작 링크 앵커를 #install에서 #quick-start로 변경하고, "Evidence" 항목에 releases 링크를 추가하며, "Source" 섹션의 라이선스 표기를 MIT에서 Apache-2.0으로 변경했습니다.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Two-Weeks-Team/memex#21: 두 PR 모두 index.html 푸터의 링크 항목(텍스트/URL/앵커)을 수정해 내용 동기화를 맞추는 변경입니다.
  • Two-Weeks-Team/memex#28: 두 PR 모두 랜딩 페이지 콘텐츠를 index.html에서 업데이트하여 사용자에게 시스템 정보를 동기화합니다.

Poem

폴딩의 시간이 변했고 ⏱️
버전도 한 단계 올라가고 🐰
푸터 링크들이 정렬되니
문서의 조화를 찾았도다 ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed PR 제목이 주요 변경사항을 충분히 포괄하며, 문서 정확성 개선(라이선스, 버전, watcher, 테스트, 앵커)을 명확하게 요약하고 있습니다.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/landing-accuracy-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation in index.html to reflect recent project changes. Key updates include changing the file watcher and poller descriptions from notify / 12s to a ~60 s poll, updating the test counts, referencing the v0.1.2 release with Homebrew Cask installation instructions, changing the license mention from MIT to Apache-2.0, and correcting several links. No review comments were provided, so there is no feedback to address.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@index.html`:
- Line 4318: 문구 "Auto-indexes on save (~60 s poll · content-hash dedup)"가 이벤트
기반(on save)과 폴링 기반을 혼용하므로 문서를 일관되게 폴링 방식으로 수정하세요: 해당 텍스트(예: "Auto-indexes on
save (~60 s poll · content-hash dedup)")를 폴링 전용 표현으로 바꿔 "Auto-indexes (≈60 s
poll · content-hash dedup)" 또는 "Auto-indexes via 60s polling (content-hash
dedup)" 같은 단일한 폴링 문구로 교체해 주세요.
- Around line 4311-4313: The HTML shows a mismatch between the anchor href
"https://github.com/Two-Weeks-Team/memex/releases/latest" and the visible text
"v0.1.2 release"; update either the href or the text so they match: either
change the href to the specific tag URL for v0.1.2 (so the anchor and the fixed
version remain consistent) or change the link text to a non-versioned phrase
like "latest release" (so it matches the releases/latest URL); adjust the <a>
element text next to the <code>.dmg</code> and the brew instruction accordingly
(search for the anchor element around "releases/latest" and the adjacent "v0.1.2
release" text).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8689cb9a-c3ba-452b-b1ee-4c7225f5ba40

📥 Commits

Reviewing files that changed from the base of the PR and between 65b9a1c and eb5e66e.

📒 Files selected for processing (1)
  • index.html

Comment thread index.html
Comment thread index.html Outdated
sgwannabe added 2 commits May 31, 2026 01:13
- Version label on the /releases/latest link was hardcoded 'v0.1.2 release',
  which drifts on the next release → make it version-agnostic 'latest release'
  (still notes signed & notarized).
- 'Auto-indexes on save' contradicted '~60 s poll' (on-save implies event-driven,
  but it polls) → 'Auto-indexes new sessions (~60 s poll · content-hash dedup)';
  also dropped 'on save' from the run-side paragraph.

Refs PR #46 review comments
Align the README license attribution with the landing footer ("Two-Weeks-Team")
and the repo org. The LICENSE file is stock Apache-2.0 with no name filled in,
so there is no LICENSE/README conflict — this is just the attribution string.

Bundled with the landing accuracy pass (PR #46) as a consistency fix.
@sgwannabe sgwannabe changed the title docs(landing): fix stale claims + dead links (license, version, watcher, tests, anchors) docs: landing accuracy fixes + README copyright (license/version/watcher/tests/anchors) May 30, 2026
@sgwannabe sgwannabe merged commit 0141082 into main May 30, 2026
5 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