Skip to content

docs: clarify automatic checks in built-in editor - #138

Open
frobel0520 wants to merge 1 commit into
abhiksark:devfrom
frobel0520:fix/issue-78-editor-docs
Open

docs: clarify automatic checks in built-in editor#138
frobel0520 wants to merge 1 commit into
abhiksark:devfrom
frobel0520:fix/issue-78-editor-docs

Conversation

@frobel0520

Copy link
Copy Markdown

Summary

Closes #78.

Clarify that the automatic edit-check-advance loop is provided by the built-in editor.

Document that external editors require saving the exercise and running pythonlings run manually. Update the how-it-works, quick-start, and homepage documentation to keep the workflow description consistent.

Tests

  • mkdocs build --strict — passed
  • python -m pythonlings --root tests/fixtures/passing_curriculum verify — passed (passing1, passing2)
  • python -m pytest -q — 208 passed, 7 failed in this Windows environment:
    • 6 failures cannot create symlinks (WinError 1314)
    • 1 failure resolves an older installed pythonlings package without pythonlings.main
  • git diff --check — passed

The strict documentation build also reports only existing warnings: the future MkDocs 2.0 compatibility warning and docs-site/AGENTS.md being outside the navigation.

Screenshots

Not applicable; documentation wording only.

Checklist

  • Updated docs when behavior changed
  • Added or updated tests — documentation-only change
  • Verified python -m pytest -q — run; environment-only failures are documented above

@coderabbitai

coderabbitai Bot commented Aug 26, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d3dae895-ae1a-40f4-a94c-9dfb905aef8f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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