P0–P2 polish: badges, architecture diagram, output mock-up, RU mirror, CI#1
Merged
Conversation
…, CI
P0 — credibility & accuracy
- Hero: badges for License, Stars, Validate CI, Built on
notebooklm-mcp-cli, Claude Code Opus 4.7, MCP, platforms
- Hero blurb leads with concrete production proof: 7 commands,
41K-message Telegram forum tested, 30+ frameworks
- Flagship value-prop quote ("MCP server = hands · workflow commands =
hands + a checklist") elevated to a callout under the hero
- Topics + description applied via gh api after merge
P1 — structural strengthening
- docs/architecture.svg — pipeline diagram showing how a single slash
command drives a deterministic three-phase recipe (Collect → Analyse →
Artifacts) over notebooklm-mcp-cli MCP tools
- docs/output-mockup.svg — visual mock-up of /research output:
structured findings, patterns, contradictions with inline citations
- "What /research returns" section anchored by output-mockup.svg
- "Measured impact" table — 5 production scenarios with
before/after numbers
- "When to use which research command" decision helper
- "Limitations" section — cookie expiry, 500K word cap, /edit-source
workaround caveat, forum heuristic, opaque rate limits, Claude Code
only, Windows-only notifications, upstream MCP dependency
- "Related" cross-links to all three sister repos:
claude-code-antiregression-setup, ai-context-hierarchy, claude-statusline
- Project structure tree now matches actual filesystem
- CLAUDE.md — Level 1 file documenting architecture, key files,
CRITICAL RULES, commands, patterns. Pairs with ai-context-hierarchy.
- CHANGELOG.md (Keep a Changelog) starting at 0.1.0 → 0.2.0
- CONTRIBUTING.md with priority list (Linux/macOS native notifications,
expanded URL dictionary, new slash commands, locale translations,
chunker improvements for WhatsApp/Discord/Slack)
- .github/workflows/validate.yml — bash -n, ShellCheck error severity,
Python compile, command frontmatter check, SVG well-formed XML, every
docs/* asset referenced from README exists, internal Markdown links
resolve
P2 — content
- README.ru.md fully mirrored to the new EN structure with the same
badges, diagrams, Limitations, Measured impact, Related, decision
helper. Russian-language hero blurb leads with the same production
numbers.
- Author signature expanded with Habr / dev.to profile links
Excluded (P3 separate work):
- Habr / dev.to companion article (no NotebookLM-specific article exists
yet; documented as next traffic-driver in CHANGELOG notes)
- Issue / PR to jacob-bd/notebooklm-mcp-cli proposing reciprocal link
- awesome-claude-code submission (channel still locked for non-collaborators)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Single PR addressing the README/structure gap identified in deep comparison with the Hydrowatch standard. The actual workflow logic was already strong (clear problem statement, raw-MCP-vs-commands table, 41 K-message Telegram production test). The README was understating it: no architecture diagram, no output preview, no CI, no Limitations, no cross-link to the three sister repos.
What changed
P0 — credibility & accuracy
notebooklm-mcp-cli, Claude Code Opus 4.7, MCP, platformsgh apiafter mergeP1 — structural strengthening
docs/architecture.svg— pipeline diagram. One slash command drives a deterministic three-phase recipe (Collect → Analyse → Artifacts) overnotebooklm-mcp-cliMCP tools.docs/output-mockup.svg— visual mock-up of/researchoutput: structured findings, patterns, contradictions with inline citations./researchreturns" section anchored by the mock-up./edit-sourceworkaround caveat, forum heuristic, opaque NotebookLM rate limits, Claude Code only, Windows-only notifications, upstream MCP dependency.CLAUDE.mdfor this repo — Level 1 file documenting architecture, CRITICAL RULES, commands, patterns. Pairs with theai-context-hierarchypattern.CHANGELOG.md(Keep a Changelog) starting at 0.1.0 → 0.2.0.CONTRIBUTING.mdwith priority list (Linux/macOS native notifications, expanded URL dictionary, new slash commands, locale translations, chunker improvements for WhatsApp/Discord/Slack)..github/workflows/validate.yml—bash -n, ShellCheck error severity, Python compile, command frontmatter check, SVG well-formed XML, everydocs/*asset referenced from README exists, internal Markdown links resolve.P2 — content
README.ru.mdfully mirrored to the new EN structure with the same badges, diagrams, Limitations, Measured impact, Related, decision helper.What is NOT in this PR
CHANGELOG.mdnotes as the next traffic-driver.jacob-bd/notebooklm-mcp-cliproposing reciprocal link. Tracked separately.awesome-claude-codesubmission — that channel currently blocked for non-collaborators across the maintainer's repo.Test plan
bash -nclean onscripts/nlm-auth-check.shpython -m py_compileclean onscripts/telegram-chunker.pycommands/*.mdhas a# /commandheading on first linedocs/*assets referenced from README and README.ru.md exist🤖 Generated with Claude Code