Docs/agent templates - #165
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Comment on lines
+355
to
+362
| const result = await getCarrierForNumber("MSCU1234567", "YOUR_API_KEY"); | ||
| if (result.autoSelect) { | ||
| // Auto-fill carrier dropdown | ||
| carrierDropdown.value = result.scac; | ||
| } else if (result.needsConfirmation) { | ||
| // Show suggestion with confirmation prompt | ||
| showCarrierSuggestion(result.carrier, result.candidates); | ||
| } |
There was a problem hiding this comment.
syntax: Missing indentation for code inside if blocks.
Suggested change
| const result = await getCarrierForNumber("MSCU1234567", "YOUR_API_KEY"); | |
| if (result.autoSelect) { | |
| // Auto-fill carrier dropdown | |
| carrierDropdown.value = result.scac; | |
| } else if (result.needsConfirmation) { | |
| // Show suggestion with confirmation prompt | |
| showCarrierSuggestion(result.carrier, result.candidates); | |
| } | |
| // Usage | |
| const result = await getCarrierForNumber("MSCU1234567", "YOUR_API_KEY"); | |
| if (result.autoSelect) { | |
| // Auto-fill carrier dropdown | |
| carrierDropdown.value = result.scac; | |
| } else if (result.needsConfirmation) { | |
| // Show suggestion with confirmation prompt | |
| showCarrierSuggestion(result.carrier, result.candidates); | |
| } |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/api-docs/in-depth-guides/auto-detect-carrier.mdx
Line: 355:362
Comment:
**syntax:** Missing indentation for code inside `if` blocks.
```suggestion
// Usage
const result = await getCarrierForNumber("MSCU1234567", "YOUR_API_KEY");
if (result.autoSelect) {
// Auto-fill carrier dropdown
carrierDropdown.value = result.scac;
} else if (result.needsConfirmation) {
// Show suggestion with confirmation prompt
showCarrierSuggestion(result.carrier, result.candidates);
}
```
<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>
How can I resolve this? If you propose a fix, please make it concise.
dodeja
force-pushed
the
docs/agent-templates
branch
from
December 17, 2025 18:05
f85814c to
bc9b2a4
Compare
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.
Greptile Summary
This PR adds comprehensive documentation for the new Infer Tracking Number API (beta) and establishes agent/writing guidelines for future documentation work.
Major additions:
AGENTS.md,WRITING_GUIDE.md) defining repository structure, coding style, documentation standards, and voice/terminology conventionsdocs/api-docs/in-depth-guides/auto-detect-carrier.mdx) - 459-line comprehensive tutorial with code examples for JavaScript, Python, and cURLdocs/api-docs/api-reference/tracking-requests/auto-detect-carrier.mdx) for the Infer Number endpoint/tracking_requests/infer_numberendpoint with full schema definitionsdocs/updates/home.mdx) documenting the new featurehome.mdx,tracking-shipments-and-containers.mdx,quickstart.mdx) linking to the new Auto-Detect Carrier featuremint.jsonadding Updates tab and new guide linksIssues found:
auto-detect-carrier.mdxhave missing indentation (lines 344-351, 355-362)agent.md,claud.md,docs/AGENTS.md,docs/claud.md) - all identicalConfidence Score: 4/5
docs/api-docs/in-depth-guides/auto-detect-carrier.mdx- fix the indentation and backtick issues in code examples before mergingImportant Files Changed
/tracking_requests/infer_numberendpoint with request/response schemasSequence Diagram
sequenceDiagram participant User as User/Developer participant API as Terminal49 API participant Infer as Infer Number Endpoint participant Tracking as Tracking Request Endpoint Note over User,Tracking: New Auto-Detect Carrier Flow (Documented in this PR) User->>Infer: POST /tracking_requests/infer_number<br/>{number: "MSCU1234567"} activate Infer Infer->>Infer: Analyze number pattern<br/>Check ML predictions<br/>Validate format Infer-->>User: Return prediction<br/>{scac: "MSCU", confidence: 1.0,<br/>decision: "auto_select"} deactivate Infer alt Decision: auto_select (confidence ≥ 95%) User->>User: Auto-fill SCAC in form else Decision: needs_confirmation (70-95%) User->>User: Show suggestion, ask user else Decision: no_prediction (< 70%) User->>User: Manual SCAC selection end User->>Tracking: POST /tracking_requests<br/>{request_number, scac, request_type} activate Tracking Tracking->>Tracking: Create tracking request<br/>Query carrier systems Tracking-->>User: Return tracking request<br/>{status: "pending"} deactivate Tracking Note over User,Tracking: Documentation additions:<br/>- Agent guidelines (AGENTS.md, WRITING_GUIDE.md)<br/>- API guide (auto-detect-carrier.mdx)<br/>- API reference (OpenAPI spec)<br/>- Cross-links in existing docs