Skip to content

docs: align notebook provider selection and docker build troubleshooting#253

Draft
cursor[bot] wants to merge 1 commit intomainfrom
cursor/codebase-documentation-alignment-6839
Draft

docs: align notebook provider selection and docker build troubleshooting#253
cursor[bot] wants to merge 1 commit intomainfrom
cursor/codebase-documentation-alignment-6839

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor bot commented Apr 20, 2026

Description

Align documentation with recently changed notebook provider-selection behavior and Docker build constraints so setup and troubleshooting match current source behavior.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • New lab or capstone project
  • Documentation update
  • Test improvement
  • Breaking change (fix or feature that would cause existing functionality to not work)

Related Issues

Fixes #(issue number)

Changes Made

  • Updated docs/guides/colab-guide.md with the verified provider auto-selection order used in current notebooks (ANTHROPIC_API_KEYOPENAI_API_KEYGOOGLE_API_KEY → local Ollama).
  • Added explicit failure-mode guidance for No LLM provider configured... to docs/guides/troubleshooting-guide.md, including Colab secret setup and Ollama fallback checks.
  • Updated docker/README.md with current build stability constraints from docker/Dockerfile (base digest pin, unicorn==2.0.1.post1 compatibility with angr, temporary ssdeep exclusion) plus rebuild/recovery steps.
  • Expanded Docker failure troubleshooting in docs/guides/troubleshooting-guide.md with concrete recovery commands and pin-verification checks.

Testing

Describe how you tested your changes:

  • Ran pytest tests/ successfully
  • Tested in Docker with docker-compose run test
  • Manually tested the feature/fix
  • Added new tests for the changes

Manual validation performed:

  • Verified notebook provider setup logic and error message against source in notebooks/lab15_llm_log_analysis.ipynb.
  • Verified Docker stability statements against source in docker/Dockerfile.
  • Verified diffs are documentation-only and scoped to existing docs files.
  • Attempted python3 -m pytest tests/test_curriculum_integrity.py -v, but pytest is unavailable in this execution environment (No module named pytest).

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my 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
  • New and existing tests pass locally with my changes
  • No API keys or secrets are included in the changes

Learning Impact (for lab changes)

If this PR affects labs, describe:

  • Skills learners will gain: N/A (documentation-only)
  • Prerequisites updated: N/A
  • Estimated time impact: N/A

Screenshots (if applicable)

Add screenshots to help explain your changes.

Open in Web View Automation 

Co-authored-by: Raymond DePalma <depalmar@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

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.

1 participant