AVO-2568: document how the import API decides "Include in Codegen"

[ada-avo]

What changed?

Pairs with avohq/monorepo#9953, which makes the tracking-plan import default a newly attached source to "Include in Codegen" whenever the workspace's plan allows codegen and the source is codegen-configured — the same rule the Avo UI applies when you attach a source by hand. Before that change the import always left codegen off, silently.

The import API reference said nothing about the setting. The sources row said only "Only the name field is extracted", which left readers to guess what happened to the implementWithCodegen field the Avo export writes into that same array — and the answer ("ignored, but the setting is still decided for you") is the thing a customer automating their plan needs to know.

Two edits to pages/reference/public-api/import-tracking-plan.mdx:

• A new Include in Codegen section covering when the import turns it on, when it doesn't (unconfigured sources, and any source the import itself creates), that it only applies on first attach so a UI toggle is never overwritten by a later import, and where to go — the MCP save_items tool or the UI — to change it on an already-attached source.
• The sources row in the field table now says implementWithCodegen is ignored and links to that section.

How to test this PR:

Preview the Import Tracking Plan reference page: the new section renders between the parse-error list and Import Methods, and the anchor link from the sources row's Notes cell resolves to it.

Every claim is checked against the implementation on the monorepo branch: the default comes from IncludeSourceInCodegenDefaultUseCase.includeInCodegenByDefault (plan availability AND a source with a language, platform, and destination), the parser still reads only name from each source entry, and ImportParserFiltering carries only sources that are new to an event — which is what makes the "never overwritten" claim true.

---

Generated by Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified that importing the sources field includes source names but ignores code generation settings.
  • Added guidance on how code generation inclusion is determined for new sources.
  • Documented how existing settings are preserved during re-imports and updated through available tools or the UI.

[linear-code]

AVO-2568

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
docs	Ready	Preview	Aug 18, 2026 1:07pm

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 044dbbad-d9c3-4879-bcc2-ece966bc393f

📥 Commits

Reviewing files that changed from the base of the PR and between c259b61 and efbc7e1.

📒 Files selected for processing (1)

• pages/reference/public-api/import-tracking-plan.mdx

Limit details: You’ve used all 5 included reviews currently available under your plan. You completed 50 included PR reviews in the past 7 days; at that activity level, included reviews refill at 5 reviews per hour.

---

📝 Walkthrough

Walkthrough

The import tracking plan documentation now explains that sources imports source names only. It also documents Codegen inclusion rules for newly attached sources, re-import behavior, and supported methods to change the setting.

Changes

Codegen inclusion documentation

Layer / File(s)	Summary
Document Codegen inclusion rules pages/reference/public-api/import-tracking-plan.mdx	The sources field documentation states that implementWithCodegen is ignored. A new section documents prerequisites, defaults, re-import preservation, and supported setting changes.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to efbc7

This localized documentation update clarifies existing import behavior and adds an anchor link without changing product behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: thoragudf

Poem

I’m a rabbit with docs in my paw,
Codegen rules now follow the law.
New sources know where to go,
Old settings stay in tow.
Clear import paths make carrots grow!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the documentation change for the Import Tracking Plan API's "Include in Codegen" behavior.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/hopeful-edison-lb2dgh

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

pages/reference/public-api/import-tracking-plan.mdx

Parsing error: Unexpected token (1:0)

Usage-based review receipt

• Mode: Continue automatically
• Reviewed files: 1
• Charged: $0.25
• View usage details

Note

This review was completed with usage-based billing: files reviewed beyond your plan's included limits are billed at $0.25/file. Track spend and usage in your billing settings.

---

_{Comment @coderabbitai help to get the list of available commands.}

[logason]

📝 Changed routes:

…i/import-tracking-plan
(view full size)

Commit efbc7e1 (https://docs-oqb4ll0r9-teamavo.vercel.app).