Skip to content

Conversation

@Ortimis
Copy link
Contributor

@Ortimis Ortimis commented Jul 18, 2025

Fixes #646
Also addresses #644

Workflow checklist

Automation

Closes #646

PR-Assignee

Reviewer

  • 🐙 Follow the Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

@Ortimis Ortimis changed the title Improve intro texts #646 Improve intro texts Jul 18, 2025
@FlorianK13 FlorianK13 self-requested a review July 18, 2025 14:05
Copy link
Member

@FlorianK13 FlorianK13 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 text. I left some comments, but I like the overall changes and think they are helpful for users.

@Ortimis Ortimis marked this pull request as draft December 11, 2025 09:34
@Ortimis Ortimis marked this pull request as ready for review December 11, 2025 09:44
@Ortimis
Copy link
Contributor Author

Ortimis commented Dec 11, 2025

Fixed the formatting issues in the rst syntax @FlorianK13
I'd also suggest moving to .md alltogether, seems much less annoying...

@FlorianK13
Copy link
Member

We switched to .rst some time ago to have a unified README template in all OpenEnergyPlatform repos. But I also start to question he usage of .rst here as well...

Copy link
Member

@FlorianK13 FlorianK13 left a comment

Choose a reason for hiding this comment

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

@Ortimis I added a few minor changes - you can commit them directly within the github User interface if you agree with them.

Ortimis and others added 3 commits December 11, 2025 14:23
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
@Ortimis
Copy link
Contributor Author

Ortimis commented Dec 11, 2025

committed them!

Copy link
Member

@FlorianK13 FlorianK13 left a comment

Choose a reason for hiding this comment

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

Wanted to merge, but found more issues.

Ortimis and others added 2 commits December 11, 2025 15:32
Co-authored-by: Florian Kotthoff <[email protected]>
Co-authored-by: Florian Kotthoff <[email protected]>
FlorianK13
FlorianK13 previously approved these changes Dec 11, 2025
@FlorianK13
Copy link
Member

@nesnoj Do we have clear rules for our changelog file? Do we add changes to the README to the Changelog?

@nesnoj
Copy link
Collaborator

nesnoj commented Dec 11, 2025

@nesnoj Do we have clear rules for our changelog file? Do we add changes to the README to the Changelog?

No rule for this I think but I'd do so - also the docs intro page is adjusted ;)

@FlorianK13 FlorianK13 self-requested a review December 12, 2025 10:01
@FlorianK13
Copy link
Member

@Ortimis can you adapt the CHANGELOG.md file so that the first entries look like that:

# Changelog

All notable changes to this project will be documented in this file.
For each version important additions, changes and removals are listed here. 

The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [v0.XX.X] unreleased - 202X-XX-XX
### Added

### Changed
- Adapt introduction text in README and docs
  [#647](https://github.com/OpenEnergyPlatform/open-MaStR/pull/647)
### Removed


## [v0.16.0] Partial downloads with open-MaStR PartialPumpkinPull - 2025-11-26
### Added

@FlorianK13
Copy link
Member

Test fail because of credentials error

@FlorianK13 FlorianK13 merged commit 3d7e6b4 into OpenEnergyPlatform:develop Dec 16, 2025
0 of 9 checks passed
nesnoj added a commit that referenced this pull request Dec 18, 2025
Introduced in #647
nesnoj added a commit that referenced this pull request Dec 18, 2025
Introduced in #647
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Intro texts are somewhat confusing to uninitiated users

3 participants