Skip to content

sdk: declare readme and point Documentation at bittensor.com/docs#2866

Merged
IntiTechnologies merged 1 commit into
mainfrom
sdk-readme-docs-link
Jul 12, 2026
Merged

sdk: declare readme and point Documentation at bittensor.com/docs#2866
IntiTechnologies merged 1 commit into
mainfrom
sdk-readme-docs-link

Conversation

@unarbos

@unarbos unarbos commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • sdk/python/pyproject.toml never declared readme, so the first v11 upload would have rendered an empty PyPI project page; declare it.
  • Add Documentation (https://bittensor.com/docs) and Repository project URLs so they appear in the PyPI sidebar.
  • README now leads with the docs link and states that this package supersedes bittensor-cli and bittensor-wallet — those PyPI pages rank highly and need somewhere current to send people.

Docs/packaging metadata only; no code changes.

Made with Cursor

The published wheel had no long_description, so the PyPI project page
would render empty once v11 ships. Declare the README, add
Documentation/Repository project URLs, and state up front that this
package supersedes bittensor-cli and bittensor-wallet.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel

vercel Bot commented Jul 12, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
subtensor Ready Ready Preview, Comment Jul 12, 2026 6:02pm

Request Review

@github-actions

github-actions Bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

🛡️ AI Review — Skeptic (security review)

VERDICT: SAFE

MEDIUM scrutiny: 117-day-old account, but a repository writer with substantial contributions, matching commit authorship, and no Gittensor association; sdk-readme-docs-link → main.

The 12-line diff is limited to README content and standard Python package metadata. It introduces no executable code, dependencies, build hooks, runtime behavior, or changes to trusted AI-review instructions.

Findings

No findings.

Conclusion

No malicious behavior or security vulnerability was found.


🔍 AI Review — Auditor (domain review)

VERDICT: 👎

UNKNOWN gittensor association; established contributor with repository write access and substantial prior contributions.

The packaging metadata and README changes are consistent with the PR description. No build or spec-version bump is needed. PR #2850 merely touches the same files for unrelated E2E documentation/configuration changes and is not a duplicate.

Findings

Sev File Finding
HIGH PR base branch Non-deployment PR targets main (off-diff)

Other findings

  • [HIGH] Non-deployment PR targets main (PR base branch) — Repository policy requires ordinary changes to target devnet; main is reserved for the documented promotion flow or hotfixes. This packaging/documentation PR is neither. Retarget the PR from main to devnet.

Conclusion

The documentation changes are sound, but this non-deployment PR violates the repository’s branch strategy. Retarget it to devnet before merging.

@github-actions

Copy link
Copy Markdown
Contributor

🔄 AI review updated — Skeptic: SAFE Auditor: 👎

@IntiTechnologies IntiTechnologies left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs/packaging metadata only. Auditor's objection (target devnet, not main) is stale policy: devnet is a ruleset-locked CI mirror since the release-train redesign; ordinary PRs merge to main.

@IntiTechnologies IntiTechnologies merged commit 82142f9 into main Jul 12, 2026
58 of 59 checks passed
@unarbos unarbos deleted the sdk-readme-docs-link branch July 13, 2026 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants