fix(docs): sync architecture.md DAG with web/ package structure (issue #247)#249
Merged
Conversation
…#247) docs/architecture.md and docs/project-structure.md still described the project's web layer as a single web.py module -- stale since the web.py -> web/ package refactor that landed alongside issue #125, long before #186/#187/#129 built on top of it. architecture.md: replaced the single web.py row with the five actual modules (server.py/viewmodels.py/downloader_adapter.py/glossary_adapter.py/ commands.py), each with its real layer and description; updated the DAG diagram to the modules' actual imports (verified by grepping each file's `from stepik_grader...` lines rather than assuming); updated the bottom layer diagram and the "future web layer" note (now closed, not future). project-structure.md: replaced the web.py tree line with the web/ package's actual file tree (including static/); added core/result.py and core/runner.py, which existed in the codebase but were missing from this tree entirely; corrected the stale "660+ тестов" count to the current order of magnitude (967 collected). cli/interactive.py and cli/rendering.py were already present in both docs from earlier work -- verified, no changes needed there. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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
1 participant
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
docs/architecture.mdanddocs/project-structure.mdstill described the project's web layer as a singleweb.pymodule — stale since theweb.py→web/package refactor that landed with feat(web): реализовать рабочую область проверки решения #125, well before feat(web): добавить Downloader workflow для загрузки тестов Stepik #186/feat(web): добавить microbench / режим 4 в WEB UI #187/test(web): покрыть основные user journeys локального WEB MVP #129 built more onto it.architecture.md: replaced the singleweb.pyrow with the five actual modules (server.py/viewmodels.py/downloader_adapter.py/glossary_adapter.py/commands.py), each with its real layer/description; DAG diagram updated to the modules' actual imports (verified via grep, not assumed); bottom layer diagram and the "future web layer" note updated (closed, not future).project-structure.md: replaced theweb.pytree line with the package's actual file tree (includingstatic/); addedcore/result.py/core/runner.py, which existed in the codebase but were missing from this tree entirely; corrected the stale "660+ тестов" count.cli/interactive.py/cli/rendering.pywere already present in both docs from earlier work — verified, no changes needed there.Test plan
pytest tests/test_check_docs_guardrails.py -q— 9 passed (1 pre-existing unrelated Windows subprocess flake on retry, confirmed via directpython scripts/check_docs_guardrails.pyrun — all 322 local Markdown links resolve)grep'd actual imports insrc/stepik_grader/web/*.py🤖 Generated with Claude Code