Document the Scenario Explorer on the docs landing page

[maxnutz]

Summary

• Rewrite docs/index.md to lead with Scenario Explorer info (registration requirement, model-name matching rule, e-mail notification on large submissions) instead of burying it below the API-reference pointer.
• Call out the config flags that affect submission validity: convert_units, map_country_codes_to_names, aggregation_level.
• Add a ## Contributing section linking to contributing.md (added in a follow-up PR for fill documentation with life and style #82, part 3 of 3) — until that PR merges, mkdocs build emits a non-fatal warning for this one link (target is not found among documentation files); it resolves once the contributing page lands.

Part 2 of 3 for #82 (execution order: API docs cleanup → this → contributing page).

Test plan

• mkdocs build succeeds (one expected non-fatal warning for the not-yet-existing contributing.md link)
• Manually reviewed rendered landing page content
• pixi run test — 201 passed

🤖 Generated with Claude Code

Summary by Sourcery

Rework the docs landing page to foreground Scenario Explorer usage and submission requirements before the API reference.

Documentation:

• Expand the docs landing page with detailed guidance for submitting processed outputs to the PyPSA-AT Scenario Explorer, including model name constraints, registration, and notification behavior.
• Highlight configuration flags that influence Scenario Explorer submission validity and briefly explain their impact on outputs.
• Add a Contributing section entry point on the docs landing page that links to the contributing guidelines page.

[sourcery-ai]

Reviewer's Guide

Updates the docs landing page to focus on Scenario Explorer usage and configuration details, restructures content into clearer sections, and adds a link to the upcoming contributing guide.

Flow diagram for Scenario Explorer submission validation based on config flags

flowchart TD
    A[Prepare PyPSA network results] --> B[Run PyPSA Validation Processing]
    B --> C[Export Excel output]
    C --> D[Check model_name matches Pypsa-AT v1.0 mapping]
    D --> E[Set convert_units=true]
    E --> F[Set map_country_codes_to_names to expected format]
    F --> G[Set aggregation_level to country or region as required]
    G --> H[Submit to Scenario Explorer]
    H --> I[Explorer validates submission]
    I --> J[Receive email notification on success]

Loading

File-Level Changes

Change	Details	Files
Rewrote the documentation landing page to foreground Scenario Explorer usage and submission requirements.	Replaced the brief site description with a higher-level overview of the package purpose and context in PyPSA-AT. Added a dedicated "Scenario Explorer" section explaining its role, account registration requirement, and submission workflow. Documented the strict model-name matching requirement against the workflow mappings file and where to configure it. Clarified expected submission processing time and email notification behavior for large files.	docs/index.md
Documented configuration flags that affect Scenario Explorer submission validity and output formatting.	Added descriptions for convert_units, map_country_codes_to_names, and aggregation_level and how they impact Explorer validation. Clarified output format expectations, emphasizing that exported Excel files already match Explorer requirements. Linked config usage to typical submission preparation steps.	docs/index.md
Restructured the landing page sections and added a contribution guidance entry point.	Introduced an "API Reference" section that points to the navigation-based auto-generated module docs. Added a "Contributing" section that links to contributing.md, noting that this is expected to be resolved by a follow-up PR. Improved overall information hierarchy so users see Scenario Explorer guidance before API reference.	docs/index.md

Possibly linked issues

• fill documentation with life and style #82: This PR fulfills the issue’s third task by rewriting docs/index.md with Scenario Explorer guidance and relevant configs.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The link to the pypsa-at-dev-workflow mappings file is pinned to a specific commit hash, which may drift from current model definitions; consider pointing to a tagged release or the default branch path if you expect the mappings to change over time.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The link to the `pypsa-at-dev-workflow` mappings file is pinned to a specific commit hash, which may drift from current model definitions; consider pointing to a tagged release or the default branch path if you expect the mappings to change over time.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}