Updated correct link for documentations.

app.py

@@ -20,6 +20,7 @@ from display.utils import AutoEvalColumn, fields
 # Constants
 from envs import (
     API,
+    DOCS_REPO_URL,
     EVAL_REQUESTS_PATH,
     EVAL_RESULTS_PATH,
     LEADERBOARD_REFRESH_INTERVAL,
@@ -129,7 +130,7 @@ if __name__ == "__main__":
             login_btn = gr.LoginButton(scale=1)
         gr.Markdown(
             "**First time here?** Check out the [❓ Help](#help) tab for a quick introduction and "
-            "[QANTA25 Documentation](https://github.com/maharshi95/QANTA25) "
+            f"[QANTA25 Documentation]({DOCS_REPO_URL}) "
             "for detailed examples and tutorials on how to create and compete with your own QuizBowl agents.",
             elem_classes="help-text",
         )

src/components/model_pipeline/model_pipeline.py

@@ -6,15 +6,12 @@ from app_configs import UNSELECTED_VAR_NAME
 from components import commons
 from components import typed_dicts as td
 from components.model_pipeline.state_manager import (
-    ModelStepUIState,
-    PipelineState,
+    BasePipelineValidator,
     PipelineStateManager,
-    PipelineUIState,
-    PipelineValidator,
-    TossupPipelineState,
     TossupPipelineStateManager,
 )
 from components.model_step.model_step import ModelStepComponent
+from components.structs import ModelStepUIState, PipelineState, PipelineUIState, TossupPipelineState
 from components.utils import make_state
 from workflows.structs import ModelStep, TossupWorkflow, Workflow
 from workflows.validators import WorkflowValidationError, WorkflowValidator
@@ -34,7 +31,7 @@ class PipelineInterface:
         ui_state: PipelineUIState | None = None,
         model_options: list[str] = None,
         config: dict = {},
-        validator: PipelineValidator | None = None,
+        validator: BasePipelineValidator | None = None,
     ):
         self.app = app
         self.model_options = model_options

src/components/model_pipeline/state_manager.py

@@ -11,7 +11,8 @@ from pydantic import BaseModel, ValidationError
 from app_configs import UNSELECTED_VAR_NAME
 from components import typed_dicts as td
 from components import utils
-from components.structs import ModelStepUIState, PipelineState, PipelineUIState, TossupPipelineState
+from components.structs import ModelStepUIState, PipelineState, TossupPipelineState
+from envs import DOCS_REPO_BRANCH, DOCS_REPO_URL
 from workflows.factory import create_new_llm_step
 from workflows.structs import Buzzer, BuzzerMethod, ModelStep, TossupWorkflow, Workflow
 
@@ -41,7 +42,7 @@ def strict_model_validate(model_cls: type[BaseModel], data: dict):
     return strict_class.model_validate(data)
 
 
-class PipelineValidator(ABC):
+class BasePipelineValidator(ABC):
     """Abstract base class for pipeline validators."""
 
     @abstractmethod
@@ -64,7 +65,7 @@ class PipelineStateManager:
     pipeline_state_cls = PipelineState
     workflow_cls = Workflow
 
-    def __init__(self, validator: PipelineValidator | None = None):
+    def __init__(self, validator: BasePipelineValidator | None = None):
         self.validator = validator
 
     def make_pipeline_state(self, state_dict: td.PipelineStateDict) -> PipelineState:
@@ -161,7 +162,7 @@ class PipelineStateManager:
             )
             raise new_exception from e
 
-    def _handle_pipeline_parsing_error(self, e: Exception) -> str:
+    def create_pipeline_error_response(self, e: Exception) -> str:
         """Format error messages for pipeline parsing errors with consistent styling."""
         error_template = """
         <div class="md" style='color: #FF0000; background-color: #FFEEEE; padding: 10px; border-radius: 5px; border-left: 4px solid #FF0000;'>
@@ -172,19 +173,19 @@ class PipelineStateManager:
             {help_text}
         </div>
         """
-        logger.exception(e)
+        repo_files_url = f"{DOCS_REPO_URL}/tree/{DOCS_REPO_BRANCH}"
         if isinstance(e, yaml.YAMLError):
             error_type = "Invalid YAML Error"
             help_text = "Refer to the <a href='https://spacelift.io/blog/yaml#basic-yaml-syntax' target='_blank'>YAML schema</a> for correct formatting."
         elif isinstance(e, ValidationError):
             error_type = "Pipeline Parsing Error"
-            help_text = "Refer to the <a href='https://mgor.info' target='_blank'>documentation</a> for the correct pipeline schema."
+            help_text = f"Refer to the <a href='{repo_files_url}/pipeline-schema.md' target='_blank'>documentation</a> for the correct pipeline schema."
         elif isinstance(e, ValueError):
             error_type = "Pipeline Validation Error"
-            help_text = "Refer to the <a href='https://mgor.info' target='_blank'>documentation</a> for the correct pipeline schema."
+            help_text = f"Refer to the <a href='{repo_files_url}/pipeline-schema.md' target='_blank'>documentation</a> for the correct pipeline schema."
         else:
             error_type = "Unexpected Error"
-            help_text = "Please report this issue to us at <a href='https://github.com/maharshi95/QANTA25/issues' target='_blank'>GitHub Issues</a>."
+            help_text = f"Please report this issue to us at <a href='{DOCS_REPO_URL}/issues' target='_blank'>GitHub Issues</a>."
 
         return error_template.format(error_type=error_type, error_message=str(e), help_text=help_text)
 
@@ -204,7 +205,7 @@ class PipelineStateManager:
                 config_str = json.dumps(config, indent=4, sort_keys=False)
             return config_str, gr.update(visible=False)
         except Exception as e:
-            error_message = self._handle_pipeline_parsing_error(e)
+            error_message = self.create_pipeline_error_response(e)
             return gr.skip(), gr.update(value=error_message, visible=True)
 
     def update_workflow_from_code(self, yaml_str: str, change_state: bool) -> tuple[td.PipelineStateDict, bool, dict]:
@@ -215,7 +216,7 @@ class PipelineStateManager:
             state = self.pipeline_state_cls.from_workflow(workflow)
             return state.model_dump(), not change_state, gr.update(visible=False)
         except Exception as e:
-            error_message = self._handle_pipeline_parsing_error(e)
+            error_message = self.create_pipeline_error_response(e)
             return gr.skip(), gr.skip(), gr.update(value=error_message, visible=True)
 
 

src/components/model_pipeline/tossup_pipeline.py

@@ -3,13 +3,13 @@ from loguru import logger
 
 from app_configs import AVAILABLE_MODELS, UNSELECTED_VAR_NAME
 from components import commons
-from components.structs import TossupPipelineState
+from components.structs import PipelineUIState, TossupPipelineState
 from components.typed_dicts import TossupPipelineStateDict
 from display.formatting import tiny_styled_warning
 from workflows.structs import Buzzer, TossupWorkflow
 
 from .model_pipeline import PipelineInterface
-from .state_manager import PipelineUIState, PipelineValidator
+from .state_manager import BasePipelineValidator
 
 
 def toggleable_slider(
@@ -40,7 +40,7 @@ class TossupPipelineInterface(PipelineInterface):
         ui_state: PipelineUIState | None = None,
         model_options: list[str] = None,
         config: dict = {},
-        validator: PipelineValidator | None = None,
+        validator: BasePipelineValidator | None = None,
     ):
         super().__init__(app, workflow, ui_state, model_options, config, validator)
 

src/envs.py

@@ -17,6 +17,10 @@ QUEUE_REPO = f"{OWNER}/advcal-requests"
 RESULTS_REPO = f"{OWNER}/model-results"  # TODO: change to advcal-results after testing is done
 LLM_CACHE_REPO = f"{OWNER}/advcal-llm-cache"
 
+DOCS_REPO_URL = "https://github.com/qanta-challenge/QANTA25"
+DOCS_REPO_BRANCH = "main"
+
+
 EXAMPLES_PATH = "examples"
 
 PLAYGROUND_DATASET_NAMES = {