Skip to content

Comments

Docs/commitments section#1849

Merged
nhoening merged 26 commits intomainfrom
docs/commitments-section
Feb 18, 2026
Merged

Docs/commitments section#1849
nhoening merged 26 commits intomainfrom
docs/commitments-section

Conversation

@Flix6x
Copy link
Contributor

@Flix6x Flix6x commented Dec 6, 2025

Description

  • Start documentation section on Commitment concept
  • Added changelog item in documentation/changelog.rst

Look & Feel

image

How to test

Just visit the latest docs build, or if that is failing due to an unrelated issue, run make update-docs and visit http://localhost:5000/ui/static/documentation/html/concepts/commitments.html.

Further Improvements

Grouping over devices is ongoing work in #1934.

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
…ontext

Signed-off-by: F.N. Claessen <felix@seita.nl>
…formulation

Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x added this to the 0.31.0 milestone Dec 6, 2025
@Flix6x Flix6x self-assigned this Dec 6, 2025
@Flix6x Flix6x added documentation Improvements or additions to documentation Scheduling labels Dec 6, 2025
@read-the-docs-community
Copy link

read-the-docs-community bot commented Dec 6, 2025

Documentation build overview

📚 flexmeasures | 🛠️ Build #31459243 | 📁 Comparing 37d44d4 against latest (1e6409f)


🔍 Preview build

Show files changed (5 files in total): 📝 4 modified | ➕ 1 added | ➖ 0 deleted
File Status
changelog.html 📝 modified
index.html 📝 modified
api/v3_0.html 📝 modified
concepts/commitments.html ➕ added
concepts/device_scheduler.html 📝 modified

Signed-off-by: F.N. Claessen <felix@seita.nl>
Signed-off-by: F.N. Claessen <felix@seita.nl>
@Flix6x Flix6x requested a review from nhoening December 9, 2025 09:55
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Thanks for working on this!

As you would probably expect from me, my comments are mostly about making this more useful to readers, mostly structuring.

I also would like one more hands-on example to show users the added modeling power they could have from this concept.

Oh, we should also add a note that we hope to make commitments a feature in the flex-context editor.

Flix6x and others added 11 commits January 23, 2026 11:08
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Signed-off-by: F.N. Claessen <claessen@seita.nl>
… styling for this)

Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x Flix6x requested a review from nhoening February 13, 2026 15:50
Copy link
Contributor

@nhoening nhoening left a comment

Choose a reason for hiding this comment

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

Thanks, great stuff!

I added the TOC and worked on a few text blocks myself, but no technical items.

@nhoening
Copy link
Contributor

Two questions @Flix6x :

  • The _type field is explained in theory, but no examples contain it. Why?
  • Is there a relationship between the number of commitments and the time it takes the optimizer to find a solution?

Signed-off-by: Nicolas Höning <nicolas@seita.nl>
@Flix6x
Copy link
Contributor Author

Flix6x commented Feb 18, 2026

For the first question: I think we only exposed the "each" type commitments in the commitments field for now. And I think we might soon revisit the topic of (time) groupings based on ongoing work on device groupings.

@nhoening
Copy link
Contributor

Okay so adding a small note to that effect is what I'll do for now, then merge.

@nhoening nhoening merged commit d2d93ce into main Feb 18, 2026
7 checks passed
@nhoening nhoening deleted the docs/commitments-section branch February 18, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Scheduling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants