docs: harden public adoption surfaces#197
Draft
adirothbuilds wants to merge 2 commits into
Draft
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
How Has This Been Tested?
/private/tmp/spindlex-py311-venv/bin/python -m pytest1957 passed, 8 skipped, 9 deselected, 14 warnings in 118.33spytest -m integration/private/tmp/spindlex-py311-venv/bin/python -m mkdocs build --strict/private/tmp/spindlex-py311-venv/bin/python -m build/private/tmp/spindlex-py311-venv/bin/python -m twine check dist/*site/llms.txt,site/llms-full.txt, andsite/robots.txtare generated by MkDocs.Checklist
Notes
.venvbecause async tests hitRuntimeError: 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.