Repository navigation
docs(skills): add tutorial writing guide - #540
Merged
Merged
Conversation
Make /docs select a dedicated scientific tutorial style guide while preserving the existing README/setup-page guide. Enforce the split in review and with focused contract tests.
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.
Summary
/docsselect the tutorial guide, the people-facing guide, or both according to the materialThe tutorial guide captures the approved COSMOS-Web Ring tone, the
__Contents__/"""__Section__"""notebook-source structure, concise repeated docstrings in advanced tutorial sequences, loading/evaluating/fitting distinctions, reproducible experiments, organism-wide scientific safeguards and the universal**🤖 Ask AI:**convention.API Changes
None — internal documentation, workflow guidance and tests only.
Test Plan
python -m pytest -q tests/test_docs_style_contract.py tests/test_skill_install.py::test_command_surface_block_is_current— 4 passedpython -m pytest -q -n auto --ignore=tests/test_skill_install.py— 1263 passedpython3 bin/project_discovery.py check PyAutoBrain --root "$PYAUTO_ROOT"bash bin/install.sh --check-agents-surfacegit diff --checke72ff50— CLEAN, no risk flags or claims to falsifyThe unfiltered Brain run reached 1268 passes and 17 failures in pre-existing scoped-discovery/environment tests:
install.shpasses scoped repository names after--root, which this checkout's argparse rejects, and subprocesses initially resolved/usr/bin/python3withouttomllib. Neither surface is changed by this PR; the affected non-installer suite passes with the project virtualenv first onPATH.Human-authorized Heart RED override (development only)
The live human replied “I authorize” on 2026-10-24 after the exact current RED reason was surfaced:
PyAutoLens: 2 commit(s) behind originAuthorization and evidence: #539 (comment)
This permits commit, push and opening this task's judge-tier development PR only. It does not permit merge, release, rehearsal, required-check bypass or any claim that this branch repairs Heart. Heart remains RED for release purposes; merge requires a separate human
/prmand green required GitHub checks.Full API Changes (for automation & release notes)
None — no public Python symbols, signatures, defaults or behaviours changed.
Generated by the PyAutoLabs agent workflow.