Skip to content

docs: harden public adoption surfaces#197

Draft
adirothbuilds wants to merge 2 commits into
mainfrom
adoption/public-surface-hardening
Draft

docs: harden public adoption surfaces#197
adirothbuilds wants to merge 2 commits into
mainfrom
adoption/public-surface-hardening

Conversation

@adirothbuilds

@adirothbuilds adirothbuilds commented Jun 6, 2026

Copy link
Copy Markdown
Collaborator

Description

Harden the public adoption surface for SpindleX without changing runtime behavior or bumping the package version.

This updates README/docs positioning, adds AI and crawler discovery files, adds structured issue templates for usage and compatibility reports, fixes docs examples around strict host key defaults, and refreshes citation/package metadata used by public package surfaces.

Related to #190.

Type of Change

Select exactly one option. These stable tokens are parsed by CI and release automation.

  • bug - Bug fix; creates a patch release.
  • feature - Feature or stabilization work intended for the current beta minor line; creates a patch release before 1.0.
  • feature-minor - Real feature intended to advance the beta minor line; creates a minor release before 1.0.
  • breaking - Breaking beta change; creates a minor release before 1.0.
  • docs - Documentation-only change; no release.
  • refactor - Non-functional cleanup or refactor; no release.
  • test - Test-only change; no release.

How Has This Been Tested?

  • Unit Tests: /private/tmp/spindlex-py311-venv/bin/python -m pytest
    • 1957 passed, 8 skipped, 9 deselected, 14 warnings in 118.33s
  • Integration Tests: pytest -m integration
  • Manual Test: /private/tmp/spindlex-py311-venv/bin/python -m mkdocs build --strict
  • Manual Test: /private/tmp/spindlex-py311-venv/bin/python -m build
  • Manual Test: /private/tmp/spindlex-py311-venv/bin/python -m twine check dist/*
  • Manual Test: parsed issue templates with PyYAML and verified site/llms.txt, site/llms-full.txt, and site/robots.txt are generated by MkDocs.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Notes

  • Repository topics were updated on GitHub: automation, devops, infrastructure-as-code, pure-python, sftp, ssh, asyncio, python, security-tools, sftp-client, ssh-client, ssh-server, typed-python.
  • Full pytest failed in the existing Python 3.9 .venv because async tests hit RuntimeError: There is no current event loop in thread 'MainThread'; the repo targets Python 3.11 via .python-version, so validation was rerun in a Python 3.11 venv.

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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