Add in-repo changelog to stonesense. #118
Conversation
docs/changelog.txt
Outdated
| ## New Tools | ||
|
|
||
| ## New Features | ||
|
|
||
| ## Fixes | ||
|
|
||
| ## Misc Improvements | ||
|
|
||
| ## Documentation | ||
|
|
||
| ## API | ||
|
|
||
| ## Lua | ||
|
|
||
| ## Removed |
There was a problem hiding this comment.
| ## New Tools | |
| ## New Features | |
| ## Fixes | |
| ## Misc Improvements | |
| ## Documentation | |
| ## API | |
| ## Lua | |
| ## Removed | |
| ## Fixes | |
| ## Misc Improvements | |
There was a problem hiding this comment.
I suspect the template can be reduced to just those two headers. The other categories don't make much sense for the stonesense repo
There was a problem hiding this comment.
Think we should also leave Documentation and New Features? Matbe also removed
There was a problem hiding this comment.
stonesense's docs are in the DFHack/dfhack repo. New Features could still be useful, depending on what you have a mind.
historic-Changelog.txt
Outdated
There was a problem hiding this comment.
I'd move this into the docs directory so it isn't more visible than the new "real" changelog.txt
I'd also recommend renaming it to history.txt to keep things short
There was a problem hiding this comment.
Agreed, will change in next commit
docs/changelog.txt
Outdated
| - `stonesense`: changed announcements to be right-aligned and limited it to only show the most recent 10 announcements. | ||
|
|
||
| ## Documentation | ||
| - `stonesense`: added a changelog in the stonesense repo itself (stonesense/docs/changelog.txt). |
There was a problem hiding this comment.
changes that are not user-facing do not need to go in the changelog. only things that would go in the public release notes.
There was a problem hiding this comment.
Additionally, is it not redundant to say stonesense? What should we do instead?
There was a problem hiding this comment.
stonesense is not as redundant as it seems. this file will get aggregated with the changelogs in the other repos and they all appear as a unified document in the release notes. We could potentially auto-inject a "stonesense" prefix, but that seems like more complexity than what is needed.
See: #117