Improve intro texts#647
Conversation
FlorianK13
left a comment
FlorianK13
left a comment
There was a problem hiding this comment.
Thanks for working on this text. I left some comments, but I like the overall changes and think they are helpful for users.
|
Fixed the formatting issues in the rst syntax @FlorianK13 |
|
We switched to .rst some time ago to have a unified README template in all |
FlorianK13
left a comment
FlorianK13
left a comment
There was a problem hiding this comment.
@Ortimis I added a few minor changes - you can commit them directly within the github User interface if you agree with them.
Co-authored-by: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com>
Co-authored-by: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com>
Co-authored-by: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com>
|
committed them! |
FlorianK13
left a comment
FlorianK13
left a comment
There was a problem hiding this comment.
Wanted to merge, but found more issues.
Co-authored-by: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com>
Co-authored-by: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com>
|
@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 ;) |
|
@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 |
…Ortimis/open-MaStR into feature-646-improve-intro-texts
|
Test fail because of credentials error |
3 participants
Fixes #646
Also addresses #644
Workflow checklist
Automation
Closes #646
PR-Assignee
Reviewer