Overview page sdk

[BaptisteGi]

Summary by CodeRabbit

• Documentation
  • Expanded the Python SDK overview with a detailed introduction, new "What you can do" use cases, async and sync code examples (same API), capability list, installation instructions (uv/pip and extras), a comparison vs direct API calls, and updated "Next steps" links.
  • Added product context describing target users and primary SDK use cases.
• Style
  • Added a spelling exception for the term "walkthrough."

[coderabbitai]

Walkthrough

This PR rewrites the Python SDK introduction MDX: front-matter title changed to "Python SDK overview"; MDX imports updated to use Docusaurus Tabs/TabItem and a ReferenceLink card; VideoPlayer import path adjusted. The page body replaces earlier content with an overview, "What you can do with it", async/sync code tabs, an SDK vs API comparison, key capabilities, installation tabs, and next steps. It also appends walkthrough to .vale/styles/spelling-exceptions.txt and adds a "Product context" section to AGENTS.md.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	No pull request description was provided by the author; the PR is missing all required sections from the template including Why, What changed, and How to review.	Add a comprehensive pull request description covering the motivation for the documentation changes, what was updated, and guidance for reviewers.
Title check	❓ Inconclusive	The title 'Overview page sdk' is vague and generic; it uses non-descriptive terms that don't clearly convey what the main change is about.	Revise the title to be more specific and descriptive, such as 'Add Python SDK overview documentation page' or 'Create comprehensive Python SDK introduction page with examples'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[cloudflare-workers-and-pages]

Deploying infrahub-sdk-python with    Cloudflare Pages

Latest commit:	9cb30a5
Status:	✅  Deploy successful!
Preview URL:	https://d8b17757.infrahub-sdk-python.pages.dev
Branch Preview URL:	https://bgi-overview-page.infrahub-sdk-python.pages.dev

View logs

[coderabbitai]

🧹 Nitpick comments (1)

docs/docs/python-sdk/introduction.mdx (1)

46-47: Consider renaming the loop variable to avoid shadowing.

In both examples, the tag variable created earlier is shadowed by the for tag in tags loop variable. While valid Python, this could confuse readers who may think they're still working with the originally created tag.

📝 Suggested change for async example (line 46)

     # Query all tags
     tags = await client.all(kind="BuiltinTag")
-    for tag in tags:
-        print(f"{tag.name.value} — {tag.description.value}")
+    for t in tags:
+        print(f"{t.name.value} — {t.description.value}")

📝 Suggested change for sync example (line 72)

 # Query all tags
 tags = client.all(kind="BuiltinTag")
-for tag in tags:
-    print(f"{tag.name.value} — {tag.description.value}")
+for t in tags:
+    print(f"{t.name.value} — {t.description.value}")

Also applies to: 72-73

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/docs/python-sdk/introduction.mdx` around lines 46 - 47, The loop
variable shadows the previously created variable named `tag`; rename the loop
variable in both examples (the `for tag in tags` loops) to something
non-conflicting (e.g., `t`, `listed_tag`, or `tag_item`) so readers don't
confuse it with the earlier `tag` object; update both the async example at the
first occurrence and the sync example (lines referenced) to use the new loop
variable wherever `tag.name.value` and `tag.description.value` are accessed.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/docs/python-sdk/introduction.mdx`:
- Around line 46-47: The loop variable shadows the previously created variable
named `tag`; rename the loop variable in both examples (the `for tag in tags`
loops) to something non-conflicting (e.g., `t`, `listed_tag`, or `tag_item`) so
readers don't confuse it with the earlier `tag` object; update both the async
example at the first occurrence and the sync example (lines referenced) to use
the new loop variable wherever `tag.name.value` and `tag.description.value` are
accessed.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d4cebc49-23d9-4442-8390-7f0dc216b369

📥 Commits

Reviewing files that changed from the base of the PR and between 5adcc05 and 9cb30a5.

📒 Files selected for processing (1)

• docs/docs/python-sdk/introduction.mdx

[yjouffrault]

everything looks good just need this small tweak

[yjouffrault]

Suggested change

	**Why the SDK over direct API calls:** eliminates the need to learn Infrahub's API structure, provides Python-native interfaces with built-in auth, adds advanced capabilities (batching, caching, tracking), and reduces boilerplate.
	**When to use the SDK instead of direct API calls:** eliminates the need to learn Infrahub's API structure, provides Python-native interfaces with built-in auth, adds advanced capabilities (batching, caching, tracking), and reduces boilerplate.