docs: add Agent Note launch articles#75
Conversation
📝 WalkthroughWalkthroughThis PR adds three documentation files for Agent Note's public launch: a distribution strategy document coordinating where to publish Japanese and English blog posts, an English launch announcement describing Agent Note's purpose and features, and a Japanese launch announcement with detailed technical explanation of the implementation and usage considerations. ChangesAgent Note Launch Documentation and Distribution Strategy
🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 `@docs/blog/agent-note-launch-distribution.md`:
- Line 137: Replace the inconsistent phrase “Hidden Reviewer Context” with the
canonical term “Hidden Comment” (identifier: agentnote-reviewer-context) in the
line currently reading “Copilot / CodeRabbit / Devin / Greptile に Hidden
Reviewer Context を読ませる” so it matches earlier sections and related docs; update
the phrasing to “Copilot / CodeRabbit / Devin / Greptile に Hidden Comment
(agentnote-reviewer-context) を読ませる” to standardize terminology across the
document.
In `@docs/blog/agent-note-launch.en.md`:
- Line 263: Update the time-sensitive sentence "Gemini CLI support is still
Preview" to include an explicit date qualifier (e.g., "as of YYYY-MM-DD") so it
reads like "Gemini CLI support is still Preview (as of YYYY-MM-DD)"; replace
YYYY-MM-DD with the current release or verification date and ensure the updated
phrase appears where "Gemini CLI support is still Preview" is used in
docs/blog/agent-note-launch.en.md so future readers and agents know when the
status was confirmed.
In `@docs/blog/agent-note-launch.ja.md`:
- Line 263: Update the sentence "Gemini CLI はまだ Preview 扱いです" to include a
reference date (e.g., "（2026-05-11時点）") so the preview status is anchored in
time; locate the exact string "Gemini CLI はまだ Preview 扱いです" in
docs/blog/agent-note-launch.ja.md and replace it with a version that appends the
date in parentheses using a clear YYYY‑MM‑DD format, and ensure the same dated
phrasing is applied consistently if the identical sentence appears elsewhere in
the document.
- Line 142: Update the sentence that currently reads "`git push` で
refs/notes/agentnote も共有される" to clarify that this happens only after setup:
mention that running "agent-note init" installs a pre-push hook (which calls
"agent-note push-notes") so that subsequent "git push" will share
refs/notes/agentnote; alternatively rephrase to "`agent-note init` 後、`git push`
で refs/notes/agentnote も共有される" or add a preceding sentence explaining the init +
pre-push hook requirement; apply the same conditional wording to the
corresponding English line and README occurrences referencing
refs/notes/agentnote, agent-note init, agent-note push-notes, and the pre-push
hook.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: affdb61d-750b-4719-9082-e4433bdb1893
📒 Files selected for processing (3)
docs/blog/agent-note-launch-distribution.mddocs/blog/agent-note-launch.en.mddocs/blog/agent-note-launch.ja.md
|
|
||
| - 実用編: `agent-note init` から PR Report まで | ||
| - GitHub Pages で Dashboard を公開する | ||
| - Copilot / CodeRabbit / Devin / Greptile に Hidden Reviewer Context を読ませる |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Unify the reviewer-context term across docs.
This line says “Hidden Reviewer Context,” while earlier sections and related docs use “Hidden Comment” (agentnote-reviewer-context). Please standardize wording to one canonical term to avoid drift in future agent-facing docs.
As per coding guidelines, "Review maintainer docs for accuracy against current implementation and usefulness as durable context for future AI coding agents."
🤖 Prompt for 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.
In `@docs/blog/agent-note-launch-distribution.md` at line 137, Replace the
inconsistent phrase “Hidden Reviewer Context” with the canonical term “Hidden
Comment” (identifier: agentnote-reviewer-context) in the line currently reading
“Copilot / CodeRabbit / Devin / Greptile に Hidden Reviewer Context を読ませる” so it
matches earlier sections and related docs; update the phrasing to “Copilot /
CodeRabbit / Devin / Greptile に Hidden Comment (agentnote-reviewer-context)
を読ませる” to standardize terminology across the document.
| - When Git notes are pushed, the team can read the saved conversation | ||
| - AI Ratio is an estimate, not an automatic judgment of quality or responsibility | ||
| - Different agents expose different levels of detail | ||
| - Gemini CLI support is still Preview |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Anchor “Preview” status to a date.
This support-status statement is time-sensitive; add an “as of YYYY-MM-DD” qualifier to keep the document durable for future readers and AI agents.
As per coding guidelines, "Review maintainer docs for accuracy against current implementation and usefulness as durable context for future AI coding agents."
🤖 Prompt for 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.
In `@docs/blog/agent-note-launch.en.md` at line 263, Update the time-sensitive
sentence "Gemini CLI support is still Preview" to include an explicit date
qualifier (e.g., "as of YYYY-MM-DD") so it reads like "Gemini CLI support is
still Preview (as of YYYY-MM-DD)"; replace YYYY-MM-DD with the current release
or verification date and ensure the updated phrase appears where "Gemini CLI
support is still Preview" is used in docs/blog/agent-note-launch.en.md so future
readers and agents know when the status was confirmed.
| Agent Note が Commit に Git Note を書く | ||
| │ | ||
| ▼ | ||
| `git push` で refs/notes/agentnote も共有される |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify whether repository docs/config explicitly ensure notes push behavior.
# Read-only reconnaissance only.
set -euo pipefail
echo "== Search docs for notes push instructions =="
rg -n -C2 'refs/notes/agentnote|git push|notes' docs README.md || true
echo
echo "== Search git-related setup/config snippets mentioning notes refspec =="
rg -n -C2 'remote\..*\.push|refs/notes|notesRef|notes\.displayRef|fetch\s*=.*refs/notes' . || true
echo
echo "== Search scripts/workflows that may push notes explicitly =="
rg -n -C2 'git push.*refs/notes|refs/notes/agentnote|git notes' .github docs || trueRepository: wasabeef/AgentNote
Length of output: 50377
🏁 Script executed:
# Find init implementation and any git refspec configuration
fd -t f 'init\.(ts|js)' packages/cli/src/commands/ 2>/dev/null | head -5
# Search for where git refspec or fetch/push config is set for notes
rg -n 'fetch.*notes|push.*notes|fetchRefSpec|remote.*pull|remote.*fetch' packages/cli/src/ --type ts --type js
# Look for pre-push hook or notes push automation
rg -n 'pre-push|notes.*push|push-notes|refs/notes.*push' packages/cli/src/ --type ts --type js
# Check git config template or setup
fd -t f '*.template' packages/ docs/Repository: wasabeef/AgentNote
Length of output: 7197
🏁 Script executed:
# Read the blog file around line 142 to see the full context
sed -n '100,180p' docs/blog/agent-note-launch.ja.mdRepository: wasabeef/AgentNote
Length of output: 2121
🏁 Script executed:
# Check the English version (around line 142)
sed -n '100,180p' docs/blog/agent-note-launch.en.md
# Also check the English blog for mentions of init before the push statement
rg -B5 -A5 'refs/notes/agentnote.*shared.*push|shared on.*push' docs/blog/agent-note-launch.en.mdRepository: wasabeef/AgentNote
Length of output: 3412
🏁 Script executed:
# Check line 260 area in English blog (mentioned in review "Also applies to: 260-260")
sed -n '255,265p' docs/blog/agent-note-launch.en.md
# Check if there's any mention of "agent-note init" in the setup section before line 142
sed -n '1,150p' docs/blog/agent-note-launch.ja.md | grep -i 'init\|setup\|設定\|インストール'
# Same for English
sed -n '1,150p' docs/blog/agent-note-launch.en.md | grep -i 'init\|setup'Repository: wasabeef/AgentNote
Length of output: 514
🏁 Script executed:
# Check README to see how it handles this context (lines mentioned in original search)
sed -n '113,115p' README.md
sed -n '255,260p' README.md
# Check if README mentions "agent-note init" before the "git push" statement
sed -n '1,115p' README.md | grep -i 'init\|setup' | tail -5Repository: wasabeef/AgentNote
Length of output: 682
Add conditional language to clarify that notes push requires agent-note init first.
The statement "git push で refs/notes/agentnote も共有される" is technically correct, but incomplete. Standard Git does not push refs/notes/* by default; they require explicit refspec or a git hook.
Agent Note provides this via the pre-push hook installed by agent-note init (which calls agent-note push-notes). Without running init first, git push alone will not push notes.
The blog should add conditional language such as:
- "
agent-note init後、git pushで refs/notes/agentnote も共有される" - Or restructure to establish init context before describing the push behavior
This clarification matters for:
- Users who read the blog without understanding the setup sequence
- AI agents reading this as durable documentation
- Troubleshooting when someone expects notes to be shared but skips init
The same issue appears at line 260 (en.md) and in README.md lines 113, 255-258.
🤖 Prompt for 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.
In `@docs/blog/agent-note-launch.ja.md` at line 142, Update the sentence that
currently reads "`git push` で refs/notes/agentnote も共有される" to clarify that this
happens only after setup: mention that running "agent-note init" installs a
pre-push hook (which calls "agent-note push-notes") so that subsequent "git
push" will share refs/notes/agentnote; alternatively rephrase to "`agent-note
init` 後、`git push` で refs/notes/agentnote も共有される" or add a preceding sentence
explaining the init + pre-push hook requirement; apply the same conditional
wording to the corresponding English line and README occurrences referencing
refs/notes/agentnote, agent-note init, agent-note push-notes, and the pre-push
hook.
| - Git Notes を Push すると、チーム内でその会話履歴も共有されます | ||
| - AI Ratio は推定値です。品質や責任を自動判定するものではありません | ||
| - Agent によって取れる情報の粒度が違います | ||
| - Gemini CLI はまだ Preview 扱いです |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Preview 表記に日付基準を付けてください。
対応状況は変わるため、「2026-05-11時点」のように基準日を添えると、将来の読者やAIエージェントにとって文脈が劣化しにくくなります。
As per coding guidelines, "Review maintainer docs for accuracy against current implementation and usefulness as durable context for future AI coding agents."
🤖 Prompt for 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.
In `@docs/blog/agent-note-launch.ja.md` at line 263, Update the sentence "Gemini
CLI はまだ Preview 扱いです" to include a reference date (e.g., "（2026-05-11時点）") so
the preview status is anchored in time; locate the exact string "Gemini CLI はまだ
Preview 扱いです" in docs/blog/agent-note-launch.ja.md and replace it with a version
that appends the date in parentheses using a clear YYYY‑MM‑DD format, and ensure
the same dated phrasing is applied consistently if the identical sentence
appears elsewhere in the document.
|
Closing this PR because it was created for the wrong scope. I will keep the blog drafts local and open a separate PR for the Dashboard Preview badge change. |
1 participant
Pull Request
Summary
Adds launch article drafts for Agent Note in Japanese and English, plus a Japanese distribution strategy note for where and how to publish them.
Release Note Plan
Release note: skip
Type of Change
Checklist
Notes for Reviewers
Docs-only addition. No runtime behavior changes. The launch articles intentionally focus on why Agent Note exists and how it records AI-assisted development context, rather than setup instructions.
🧑💬🤖 Agent Note
Total AI Ratio: ████████ 100%
Model:
gpt-5.4c43c955docs: add Agent Note launch articles💬 Prompts & Responses (2 total)
c43c955docs: add Agent Note launch articlesSummary by CodeRabbit