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

Docs: Added Disabled World information to README.md #2705

Merged
merged 8 commits into from
Jan 13, 2024

Conversation

nicholassaylor
Copy link
Contributor

What is this fixing or adding?

Adds section to README.md in /worlds_disabled that details why OriBF was disabled. Additionally mentions what would needs to be changed before it can be merged into main. Would appreciate input from Core Devs if the opening sentences are accurate.

How was this tested?

Previewed markdown

@nicholassaylor
Copy link
Contributor Author

This PR addresses #2468

worlds_disabled/README.md Outdated Show resolved Hide resolved
worlds_disabled/README.md Outdated Show resolved Hide resolved
nicholassaylor and others added 2 commits January 11, 2024 20:54
Meant to provide context for any updates the world may need (For example, this world would need to change to the new options sstem in 0.4.4)
Copy link
Contributor

@ReverM ReverM left a comment

Choose a reason for hiding this comment

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

LGTM

@black-sliver
Copy link
Member

Just wondering if it wouldn't be smarter to put the world's reason to be disabled inside the world? That way it wouldn't get lost when we move worlds outside of core.

something like <game_name>/README.md ->

# Game Name

## State of the world

* Missing client
* Unmaintained
* Outdated, fails to load (date)

and in the worlds_disabled/README.md you just put a ref that more documentation can probably be found in the world's readme?

@nicholassaylor
Copy link
Contributor Author

Just wondering if it wouldn't be smarter to put the world's reason to be disabled inside the world? That way it wouldn't get lost when we move worlds outside of core.

something like <game_name>/README.md ->

# Game Name

## State of the world

* Missing client
* Unmaintained
* Outdated, fails to load (date)

and in the worlds_disabled/README.md you just put a ref that more documentation can probably be found in the world's readme?

I like this idea, I will make this change when I get a chance in the morning.

Co-authored-by: black-sliver <[email protected]>
worlds_disabled/oribf/README.md Outdated Show resolved Hide resolved
worlds_disabled/oribf/README.md Outdated Show resolved Hide resolved
Copy link
Member

@black-sliver black-sliver left a comment

Choose a reason for hiding this comment

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

Thanks!

@black-sliver black-sliver merged commit 01fb44c into ArchipelagoMW:main Jan 13, 2024
7 checks passed
@nicholassaylor nicholassaylor deleted the disabled-world-docs branch January 13, 2024 21:39
Jouramie pushed a commit to Jouramie/Archipelago that referenced this pull request Feb 28, 2024
* Add rationale for OriBF being disabled

* Removed periods

* Added warning to README.md

* Apply suggestions from code review

Co-authored-by: Silvris <[email protected]>

* Added disable date

Meant to provide context for any updates the world may need (For example, this world would need to change to the new options sstem in 0.4.4)

* Moved rationale to local README
Co-authored-by: black-sliver <[email protected]>

* Apply suggestions from code review

Co-authored-by: black-sliver <[email protected]>

---------

Co-authored-by: Silvris <[email protected]>
Co-authored-by: black-sliver <[email protected]>
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.

4 participants