Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move changelog to separate file #2223

Open
wants to merge 1 commit into
base: Dev
Choose a base branch
from
Open

Conversation

fenhl
Copy link
Collaborator

@fenhl fenhl commented May 20, 2024

The readme has been getting quite long, so this PR moves the changelog to a separate CHANGELOG.md file.

I also took the opportunity to turn the link to ootrandomizer.com into a proper Markdown link.

@fenhl fenhl added Status: Needs Review Someone should be looking at it Component: Documentation Affects user-facing help messages or public API docs Type: Maintenance Code style, infrastructure, updating dependencies labels May 20, 2024
@flagrama
Copy link

Perhaps this is an opportunity to only use the wiki for released changes and only keep dev changes documented in the repo? It would probably also be nice to have a link added to the "full" readme on the wiki which in addition to the content that stays pretty static in the repo readme is regularly updated to indicate what options do and which versions they were added/modified.

@fenhl
Copy link
Collaborator Author

fenhl commented Jun 2, 2024

We should keep a full changelog somewhere in the git tree imo. As for the link to the wiki article, I'm not sure it makes sense to link to a document that starts with a copy of the same text you just read. Maybe if the setting release history was a separate document?

@flagrama
Copy link

flagrama commented Jun 2, 2024

You can always link to headings of wiki pages with as an anchor point. https://wiki.ootrandomizer.com/index.php?title=Readme#Generation_Options

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Affects user-facing help messages or public API docs Status: Needs Review Someone should be looking at it Type: Maintenance Code style, infrastructure, updating dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants