Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
43c85dd
Fix Docs
FBumann Oct 15, 2025
fa82b5f
Update Changelog and migration guide for missing breaking changes
FBumann Oct 16, 2025
a80da63
Update Migration guide
FBumann Oct 16, 2025
344cf92
Improve
FBumann Oct 16, 2025
fbac191
Use tabs in mkdocs
FBumann Oct 16, 2025
ef35d90
Update varaibel renaming
FBumann Oct 16, 2025
9f50ca2
Update variable renaming
FBumann Oct 16, 2025
cd3df05
From main
FBumann Oct 16, 2025
9390fcd
Update
FBumann Oct 16, 2025
0668042
Update
FBumann Oct 16, 2025
4fb6a6c
Update
FBumann Oct 16, 2025
8cced2a
Add links
FBumann Oct 16, 2025
cd87edf
Add emojis
FBumann Oct 16, 2025
0d03660
compact 2
FBumann Oct 16, 2025
afb0d19
Enable plugin
FBumann Oct 16, 2025
5cf023e
Update
FBumann Oct 16, 2025
e61aa02
Update
FBumann Oct 16, 2025
fc8288f
Customize
FBumann Oct 16, 2025
3d83127
Customize
FBumann Oct 16, 2025
7fb19dd
Add deps
FBumann Oct 16, 2025
5b32627
Make index.md pretty
FBumann Oct 16, 2025
f0b0d54
Fix
FBumann Oct 16, 2025
c374c25
Fix
FBumann Oct 16, 2025
23a6b5b
Fix icons
FBumann Oct 16, 2025
c1bc3f8
Fix quick nav
FBumann Oct 16, 2025
f730dfd
Use regular emojis
FBumann Oct 16, 2025
1193b86
Update landing page
FBumann Oct 16, 2025
dcd6ead
Add semantic colors
FBumann Oct 16, 2025
1a1f4a7
Add semantic colors
FBumann Oct 16, 2025
31cf8c8
More css
FBumann Oct 16, 2025
51cfdbf
Revert "More css"
FBumann Oct 16, 2025
a79e828
Revert "Add semantic colors"
FBumann Oct 16, 2025
d965143
Revert "Add semantic colors"
FBumann Oct 16, 2025
e6124ef
Merge remote-tracking branch 'origin/main' into feature/pretty-docs-w…
FBumann Oct 16, 2025
53d49c6
Fix
FBumann Oct 16, 2025
666aa64
Pin mkdocs
FBumann Oct 16, 2025
0337d4d
Add rel="noopener noreferrer" to external links opened in new
FBumann Oct 16, 2025
7629904
Remove duplication
FBumann Oct 16, 2025
7e1c277
Change colors
FBumann Oct 16, 2025
a91372a
Change colors
FBumann Oct 16, 2025
96a3407
Revert "Change colors"
FBumann Oct 16, 2025
336e04d
Revert "Change colors"
FBumann Oct 16, 2025
db945f6
Add entry to CHANGELOG.md
FBumann Oct 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ If upgrading from v2.x, see the [Migration Guide](https://flixopt.github.io/flix
### 📦 Dependencies

### 📝 Docs
- Improve docs visually

### 👷 Development

Expand Down
144 changes: 133 additions & 11 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,144 @@
{%
include-markdown "../README.md"
%}

---
title: Home
hide:
- navigation
- toc
---

<div class="hero-section">

<h1>flixOpt</h1>

<p class="tagline">Energy and Material Flow Optimization Framework</p>

<p>Model, optimize, and analyze complex energy systems with a powerful Python framework designed for flexibility and performance.</p>

<p class="hero-buttons">
<a href="getting-started/" class="md-button md-button--primary">🚀 Get Started</a>
<a href="examples/" class="md-button">💡 View Examples</a>
<a href="https://github.com/flixOpt/flixopt" class="md-button" target="_blank" rel="noopener noreferrer">⭐ GitHub</a>
</p>

</div>

## :material-map-marker-path: Quick Navigation

<div class="quick-links">
<a href="getting-started/" class="quick-link-card">
<h3>🚀 Getting Started</h3>
<p>New to FlixOpt? Start here with installation and your first model</p>
</a>

<a href="examples/" class="quick-link-card">
<h3>💡 Examples Gallery</h3>
<p>Explore real-world examples from simple to complex systems</p>
</a>

## Documentation Architecture
<a href="api-reference/" class="quick-link-card">
<h3>📚 API Reference</h3>
<p>Detailed documentation of all classes, methods, and parameters</p>
</a>
Comment on lines +37 to +40
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify internal link targets exist.

Multiple relative links (getting-started/, examples/, api-reference/, user-guide/recipes/, user-guide/mathematical-notation/, roadmap/, contribute/, changelog/) should be verified to ensure they resolve correctly in the built site. Broken links will degrade the homepage experience.

Run the following script to check that link targets exist in the docs structure:


🏁 Script executed:

#!/bin/bash
# Description: Verify that all internal homepage links target existing pages/directories

# List all referenced link targets from the homepage
links=(
  "getting-started"
  "examples"
  "api-reference"
  "user-guide/recipes"
  "user-guide/mathematical-notation"
  "roadmap"
  "contribute"
  "changelog"
  "user-guide/migration-guide-v3"
)

echo "Checking if link targets exist in docs/..."
for link in "${links[@]}"; do
  # Check for either .md file or index.md in directory
  if [ -f "docs/${link}.md" ] || [ -f "docs/${link}/index.md" ]; then
    echo "${link}"
  else
    echo "✗ MISSING: ${link}"
  fi
done

Length of output: 228



🏁 Script executed:

#!/bin/bash
# Check actual docs directory structure and find where api-reference and changelog might be
echo "=== Full docs directory structure ==="
find docs -type d -o -type f -name "*.md" | head -50

echo -e "\n=== Looking for 'api' or 'reference' files ==="
find docs -type f \( -name "*api*" -o -name "*reference*" \) 2>/dev/null

echo -e "\n=== Looking for 'changelog' or 'change' files ==="
find docs -type f \( -name "*changelog*" -o -name "*change*" -o -name "*history*" \) 2>/dev/null

echo -e "\n=== Checking docs root files ==="
ls -la docs/

Length of output: 2403


🏁 Script executed:

#!/bin/bash
# Explore docs structure to find api-reference and changelog
echo "=== Checking docs directory structure ==="
find docs -type d | sort

echo -e "\n=== Looking for api-reference ==="
find docs -type f -o -type d | grep -i "api"

echo -e "\n=== Looking for changelog ==="
find docs -type f -o -type d | grep -i "change"

echo -e "\n=== All .md files in docs ==="
find docs -name "*.md" | sort

Length of output: 1703


Create missing documentation pages for api-reference and changelog.

Verification confirms two broken links on the homepage:

  • api-reference/ – link target does not exist in docs
  • changelog/ – link target does not exist in docs

These missing pages will result in 404 errors for users. Create docs/api-reference/index.md and docs/changelog.md (or as directories with index.md) to resolve the broken links.

🤖 Prompt for AI Agents
In docs/index.md around lines 37 to 40, the links to "api-reference/" and
"changelog/" point to non-existent targets causing 404s; create the missing
documentation pages by adding docs/api-reference/index.md (or a
docs/api-reference.md) and docs/changelog.md (or a docs/changelog/index.md) with
basic frontmatter/title and placeholder content that links back to the homepage
so the links resolve and users don’t hit 404s.


<a href="user-guide/recipes/" class="quick-link-card">
<h3>📖 Recipes</h3>
<p>Common patterns and best practices for modeling energy systems</p>
</a>

<a href="user-guide/mathematical-notation/" class="quick-link-card">
<h3>∫ Mathematical Notation</h3>
<p>Understand the mathematical formulations behind the framework</p>
</a>

<a href="roadmap/" class="quick-link-card">
<h3>🛣️ Roadmap</h3>
<p>See what's coming next and contribute to the future of FlixOpt</p>
</a>
</div>

## 🏗️ Framework Architecture

<div class="architecture-section" markdown="1">

<figure markdown>
![FlixOpt Conceptual Usage](./images/architecture_flixOpt.png)
<figcaption>Conceptual Usage and IO operations of FlixOpt</figcaption>
</figure>

**FlixOpt** provides a complete workflow for energy system optimization:

- **:material-file-code: Define** your system using Python components
- **:material-cog: Optimize** with powerful solvers (HiGHS, Gurobi, CPLEX)
- **:material-chart-box: Analyze** results with built-in visualization tools
- **:material-export: Export** to various formats for further analysis

</div>

## :material-account-group: Community & Support

<div class="feature-grid" markdown="1">

<div class="feature-card" markdown="1">

:fontawesome-brands-github:{ .feature-icon }

### GitHub

Report issues, request features, and contribute to the codebase

[Visit Repository →](https://github.com/flixOpt/flixopt){target="_blank" rel="noopener noreferrer"}

</div>

<div class="feature-card" markdown="1">

:material-forum:{ .feature-icon }

### Discussions

Ask questions and share your projects with the community

[Join Discussion →](https://github.com/flixOpt/flixopt/discussions){target="_blank" rel="noopener noreferrer"}

</div>

<div class="feature-card" markdown="1">

:material-book-open-page-variant:{ .feature-icon }

### Contributing

Help improve FlixOpt by contributing code, docs, or examples

[Learn How →](contribute/){target="_blank" rel="noopener noreferrer"}

</div>

</div>


## :material-file-document-edit: Recent Updates

!!! tip "What's New in v3.0.0"
Major improvements and breaking changes. Check the [Migration Guide](user-guide/migration-guide-v3.md) for upgrading from v2.x.

📋 See the full [Release Notes](changelog/) for detailed version history.

---

## Next Steps
<div style="text-align: center; margin: 3rem 0; padding: 2rem; background: var(--md-code-bg-color); border-radius: 0.75rem;">

<h3>Ready to optimize your energy system?</h3>

<p>
<a href="getting-started/" class="md-button md-button--primary md-button--lg">▶️ Start Building</a>
</p>

- **New to FlixOpt?** Start with the [Getting Started Guide](getting-started.md)
- **Want to see examples?** Check out the [Examples Gallery](examples/index.md)
- **Need API details?** Browse the [API Reference](api-reference/index.md)
- **Looking for advanced patterns?** See [Recipes](user-guide/recipes/index.md)
- **Curious about the future?** Read our [Roadmap](roadmap.md)
</div>

---

{%
include-markdown "../README.md"
start="## Installation"
end="## License"
%}
Loading