update generate_docs.py

[chiragjn]

Note

Low Risk
Low risk documentation-only change limited to the generated home page template; no runtime or SDK behavior is affected.

Overview
Updates the generate_docs.py home page template to improve the Python SDK installation instructions by adding a Python version requirement note, switching to an upgrade-friendly pip install -U "truefoundry" command with Mintlify lines formatting, and linking to the CLI setup docs.

^{Reviewed by Cursor Bugbot for commit 026cdcc. Bugbot is set up for automated code reviews on this repo. Configure here.}

Summary by CodeRabbit

• Documentation
  • Updated installation instructions with explicit Python version requirements (3.9-3.14)
  • Modified pip install command format for clarity
  • Added reference link to CLI setup documentation

[coderabbitai]

Walkthrough

Updated the documentation generation template to enhance home page installation instructions by specifying Python version compatibility (3.9–3.14), updating the pip install command with upgrade flag and package name quoting, and including a reference to CLI setup documentation.

Changes

Cohort / File(s)	Summary
Documentation Template generate_docs.py	Modified generated installation instructions with Python version constraints (≥3.9, ≤3.14), upgraded pip command (pip install -U "truefoundry"), and added link to CLI setup guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A home page shiny, new and bright,
With Python versions set just right,
From 3.9 to 3.14 we go,
Upgrade flags and links aglow,
Installation wisdom now will flow! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, using a non-descriptive phrase that doesn't clearly convey the specific changes made to the documentation instructions.	Use a more specific title that describes the actual changes, such as 'Update home page installation instructions with Python version requirements' or 'Add Python version info and CLI setup link to install docs'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

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

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch cj-update-gen-docs-1

---

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

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

generate_docs.py (2)

177-179: ⚠️ Potential issue | 🔴 Critical

Python version requirements in documentation contradict package metadata.

The documentation states Python ≥ 3.9, ≤ 3.14 is required, but pyproject.toml specifies python = ">=3.8" with no upper bound. This will mislead users with Python 3.8 into thinking the SDK is incompatible, and falsely restrict users on Python 3.15+.

Update line 178 to match the actual package metadata:

- You need Python ≥ 3.9, ≤ 3.14 to use the Truefoundry Python SDK.
+ You need Python ≥ 3.8 to use the Truefoundry Python SDK.

🤖 Prompt for AI Agents

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

In `@generate_docs.py` around lines 177 - 179, The docs generator currently emits
a Python requirement that contradicts pyproject metadata; update the Python
version string used when creating the ClientModuleInfo for the main client in
generate_docs.py (the ClientModuleInfo instantiation that sets the Python
version requirement) so it matches pyproject.toml by using ">=3.8" (no upper
bound) instead of ">=3.9, <=3.14"; ensure the change is applied where
ClientModuleInfo(name="main_client", ...) is constructed.

---

185-186: ⚠️ Potential issue | 🟠 Major

Fix broken documentation link in the CLI docstring.

The reference to /docs/setup-cli at line 1185 is broken—no such documentation path exists in the repository. Either update the link to point to existing documentation or remove the reference until the documentation is created.

🤖 Prompt for AI Agents

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

In `@generate_docs.py` around lines 185 - 186, The CLI docstring contains a broken
link to /docs/setup-cli; locate the docstring in the same module where
_extract_client_module_info is defined (the CLI-related docstring around the
commented reference) and either replace the broken path with the correct
existing documentation URL or remove the link altogether; update the text to
refer to a valid file or a TODO placeholder and run the docs/build or search for
other references to /docs/setup-cli to ensure consistency.

🤖 Prompt for all review comments with AI agents

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

Outside diff comments:
In `@generate_docs.py`:
- Around line 177-179: The docs generator currently emits a Python requirement
that contradicts pyproject metadata; update the Python version string used when
creating the ClientModuleInfo for the main client in generate_docs.py (the
ClientModuleInfo instantiation that sets the Python version requirement) so it
matches pyproject.toml by using ">=3.8" (no upper bound) instead of ">=3.9,
<=3.14"; ensure the change is applied where ClientModuleInfo(name="main_client",
...) is constructed.
- Around line 185-186: The CLI docstring contains a broken link to
/docs/setup-cli; locate the docstring in the same module where
_extract_client_module_info is defined (the CLI-related docstring around the
commented reference) and either replace the broken path with the correct
existing documentation URL or remove the link altogether; update the text to
refer to a valid file or a TODO placeholder and run the docs/build or search for
other references to /docs/setup-cli to ensure consistency.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 552b070c-847c-4e0c-8ef6-44f67ec29531

📥 Commits

Reviewing files that changed from the base of the PR and between 2d18a13 and 026cdcc.

📒 Files selected for processing (1)

• generate_docs.py