Repository navigation
docs(#7175): document the scribe agent under docs/agents/ - #9222
Conversation
Add docs/agents/scribe.md to document the scribe agent defined in fullsend-ai/agents, covering its vision, pipeline behavior, expected outcomes, commands, control labels, and configuration options (including dedicated GCP service account setup, Jira issue creation, and operating modes). Add scribe to the summary table in docs/agents/README.md and to the sidebar navigation in docs/.vitepress/config.ts. Closes fullsend-ai#7175 Signed-off-by: anevans <anevans@redhat.com>
PR Summary by QodoDocument the Scribe agent and add it to agent navigation
AI Description
Diagram
High-Level Assessment
Files changed (3)
|
Code Review by Qodo
1.
|
- Update environment variable tables to include Default column - Clarify SCRIBE_DRY_RUN defaults to true (preview mode) - Document SCRIBE_NAME_FILTER and SCRIBE_SEARCH_QUERY workflow mapping - Expand Drive search scope guidance regarding Shared Drives - Accurately describe GCP key mounting in sandbox and credential isolation - Include agent remove step before local agent add in Jira setup - Rewrap prose paragraphs and list items to ~80 columns - Note runtime discovery from fullsend-ai/agents in docs/agents/README.md Signed-off-by: anevans <anevans@redhat.com>
E2E tests are runningAuthorization passed for this commit. See the E2E Tests workflow for results. |
|
🤖 Finished Review · ✅ Success · Started 6:34 PM UTC · Completed 6:42 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.69 |
|
Risk Assessment: moderate (2/5) DetailsDocumentation-only PR matching linked issue scope with no protected paths, elevated to moderate risk by high churn, multi-author contention, and regression history on docs/.vitepress/config.ts. Previous runRisk Assessment: moderate (2/5) DetailsDocumentation-only PR matching linked issue scope with no protected paths, elevated to moderate risk by high churn, multi-author contention, and regression history on docs/.vitepress/config.ts. Previous run (2)Risk Assessment: moderate (2/5) DetailsDocumentation-only PR matching linked issue scope with no protected paths, elevated to moderate risk by high churn, author contention, and fix history on docs/.vitepress/config.ts. Previous run (3)Risk Assessment: moderate (2/5) DetailsDocumentation-only PR matching linked issue scope with no protected paths, elevated to moderate risk by high churn, author contention, and fix history on docs/.vitepress/config.ts. |
ReviewFindingsLow
Earlier findings
Previous run<!-- fullsend:review-findings-v2:eyJ2ZXJzaW9uIjoyLCJhY3Rpb24iOiJhcHByb3ZlIiwiZmluZGluZ3MiOlt7InNldmVyaXR5IjoibWVkaXVtIiwiY2F0ZWdvcnkiOiJhcGktY29udHJhY3QiLCJmaWxlIjoiZG9jcy9hZ2VudHMvc2NyaWJlLm1kIiwiaWQiOiJmXzlhNTE3Y2FhNzc3YTEwMmUiLCJsaW5lIjoyNDQsImFjdGlvbmFibGUiOnRydWUsImRpbWVuc2lvbiI6ImNvcnJlY3RuZXNzIn0seyJzZXZlcml0eSI6Im1lZGl1bSIsImNhdGVnb3J5IjoiYXBpLWNvbnRyYWN0IiwiZmlsZSI6ImRvY3MvYWdlbnRzL3NjcmliZS5tZCIsImlkIjoiZl8zOTljMmMzMDU1Zjk3MjU1IiwibGluZSI6MjU1LCJhY3Rpb25hYmxlIjp0cnVlLCJkaW1lbnNpb24iOiJjb3JyZWN0bmVzcyJ9XSwiZGlzcG9zaXRpb25zIjpbeyJpZCI6ImZfOWE1MTdjYWE3NzdhMTAyZSIsInN0YXR1cyI6InJlc29sdmVkX2J5X2NoYW5nZSJ9LHsiaWQiOiJmXzM5OWMyYzMwNTVmOTcyNTUiLCJzdGF0dXMiOiJyZXNvbHZlZF9ieV9jaGFuZ2UifV19 --> Looks good to me Previous run (2)<!-- fullsend:review-findings-v2:eyJ2ZXJzaW9uIjoyLCJhY3Rpb24iOiJhcHByb3ZlIiwiZmluZGluZ3MiOlt7InNldmVyaXR5IjoibWVkaXVtIiwiY2F0ZWdvcnkiOiJhcGktY29udHJhY3QiLCJmaWxlIjoiZG9jcy9hZ2VudHMvc2NyaWJlLm1kIiwiaWQiOiJmXzlhNTE3Y2FhNzc3YTEwMmUiLCJsaW5lIjoyNDQsImFjdGlvbmFibGUiOnRydWUsImRpbWVuc2lvbiI6ImNvcnJlY3RuZXNzIn0seyJzZXZlcml0eSI6Im1lZGl1bSIsImNhdGVnb3J5IjoiYXBpLWNvbnRyYWN0IiwiZmlsZSI6ImRvY3MvYWdlbnRzL3NjcmliZS5tZCIsImlkIjoiZl8zOTljMmMzMDU1Zjk3MjU1IiwibGluZSI6MjU1LCJhY3Rpb25hYmxlIjp0cnVlLCJkaW1lbnNpb24iOiJjb3JyZWN0bmVzcyJ9XSwiZGlzcG9zaXRpb25zIjpbeyJpZCI6ImZfOWE1MTdjYWE3NzdhMTAyZSIsInN0YXR1cyI6InJlc29sdmVkX2J5X2NoYW5nZSJ9LHsiaWQiOiJmXzM5OWMyYzMwNTVmOTcyNTUiLCJzdGF0dXMiOiJyZXNvbHZlZF9ieV9jaGFuZ2UifV19 --> Looks good to me Earlier findings
Previous run (3)<!-- fullsend:review-findings-v2:eyJ2ZXJzaW9uIjoyLCJhY3Rpb24iOiJyZXF1ZXN0LWNoYW5nZXMiLCJmaW5kaW5ncyI6W3sic2V2ZXJpdHkiOiJtZWRpdW0iLCJjYXRlZ29yeSI6ImFwaS1jb250cmFjdCIsImZpbGUiOiJkb2NzL2FnZW50cy9zY3JpYmUubWQiLCJpZCI6ImZfOWE1MTdjYWE3NzdhMTAyZSIsImxpbmUiOjI0NCwiYWN0aW9uYWJsZSI6dHJ1ZSwiZGltZW5zaW9uIjoiY29ycmVjdG5lc3MifSx7InNldmVyaXR5IjoibWVkaXVtIiwiY2F0ZWdvcnkiOiJhcGktY29udHJhY3QiLCJmaWxlIjoiZG9jcy9hZ2VudHMvc2NyaWJlLm1kIiwiaWQiOiJmXzM5OWMyYzMwNTVmOTcyNTUiLCJsaW5lIjoyNTUsImFjdGlvbmFibGUiOnRydWUsImRpbWVuc2lvbiI6ImNvcnJlY3RuZXNzIn1dfQ== --> ReviewFindingsMedium
Labels: PR adds user-facing documentation for the scribe agent. Next steps:
|
Summary of changes in commit
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Site previewPreview: https://d54587ff-site.fullsend-ai.workers.dev Commit: |
…tials for scribe - Update agent add/remove commands to run from repo root with default .fullsend - Register local harness override using scribe.yaml relative to fullsend dir - Document tracker.jira config and FULLSEND_JIRA_* env credentials for CLI - Clarify legacy JIRA_* variables are consumed only by external scripts Signed-off-by: anevans <anevans@redhat.com>
Summary of review feedback addressed in commit
|
|
🤖 Finished Review · ✅ Success · Started 7:05 PM UTC · Completed 7:15 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.54 |
Superseded by updated review
waynesun09
left a comment
There was a problem hiding this comment.
Review-only pass: five inline findings on docs/agents/scribe.md (one HIGH, four MEDIUM). Most come from comparing the page with the scribe harness and scripts in fullsend-ai/agents and with how fullsend run validates harness env.
…d credentials - Document JIRA_* credentials used by external scribe scripts and translated to CLI - Require SCRIBE_DRY_RUN explicitly and explain post-script preview behavior - Note that all harness variables must exist in runner environment - State sandbox egress allows configured inference providers (Vertex AI and OpenAI) - Document scribe prerequisites, dogfood role, and link example workflows - Clarify built-in agent resolution vs opt-in scribe harness in README Signed-off-by: anevans <anevans@redhat.com>
Summary of review feedback addressed in commit
|
|
🤖 Finished Review · ✅ Success · Started 7:42 PM UTC · Completed 7:49 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.15 |
Superseded by updated review
|
After #9229 is merged, please rebase on |
|
🤖 Finished Review · ✅ Success · Started 1:16 PM UTC · Completed 1:25 PM UTC Commit: Runtime: pi · Model: sonnet → claude-sonnet-5-5 · Effort: high · Cost: $1.72 |
Superseded by updated review
waynesun09
left a comment
There was a problem hiding this comment.
LGTM. All five review findings are fixed in b1e692c. I checked the Jira credential flow against the scribe scripts in fullsend-ai/agents: JIRA_TOKEN and JIRA_USER_EMAIL are passed to the CLI as FULLSEND_JIRA_*, with connection settings from tracker.jira.
Summary
Documents the scribe agent defined in
fullsend-ai/agentsby addingdocs/agents/scribe.md, adding a row for Scribe to the summary table indocs/agents/README.md, and registering Scribe in the sidebar navigation indocs/.vitepress/config.ts.Related Issue
Closes #7175
Changes
docs/agents/scribe.mdfollowing the established structure of other agent docs indocs/agents/:meeting-notes(or allowlisted Jira labels) for categorization.all,comments_only,new_issues_only), Jira Cloud issue creation (fullsend issues create --tracker jira), GitLab host validation, and skills.fullsend-ai/agentsharness definition.docs/agents/README.mdto add Scribe to the agents summary table.docs/.vitepress/config.tsto include Scribe in theAgentssidebar items.Testing
make lintpasses (stage changes first, then run)npm run testpasses (Vitest tests)npx vitepress build docspasses without errorslint-docs-links,lint-md-links, and VitePress build)Checklist
!for breaking changes)