Roadmap generator module - #103
Merged
Matee-ur-Rehman merged 1 commit intoAug 29, 2026
Merged
Matee-ur-Rehman merged 1 commit into
Matee-ur-Rehman merged 1 commit into
Conversation
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.
Overview
Implements the Roadmap Generator module for Team Lambda, per the approved architecture doc (Weak-topic Detection & Roadmap Generator Proposed Structure). Generates a simple, ordered study roadmap from subject/topic input.
Design
General-purpose module — takes a list of topics as input, does not depend on Weak-topic Detection or any other module's output, matching the approved architecture doc exactly.
Callers may optionally pass per-topic priority hints (e.g. sourced from weak-topic results elsewhere) as plain data — this module never imports or depends on that source.
app/api/ is intentionally left empty, per the doc's instruction to defer API contracts until cross-team integration details are confirmed.
What was added
generators/base_generator.py, generators/roadmap_generator.py — LLM-backed (Groq) roadmap generation
models/topic.py, models/roadmap.py — input/output data models
services/roadmap_service.py — integration entry point, includes input validation
validators/topic_validator.py — topic name and step-count validation
tests/ — unit tests for validation (always run) and generation (skipped automatically if GROQ_API_KEY isn't set)
README.md, requirements.txt, .gitignore
Testing
All 7 tests pass locally with GROQ_API_KEY configured: pytest roadmap_generator/tests -q --tb=short → 7 passed
Manually verified end-to-end output — generated a 4-step roadmap for "Algorithms" (Recursion → Recursive patterns → DP foundations → Applying DP), logically sequenced with clear descriptions.