Skip to content

Commit

Permalink
Docs: Added Disabled World information to README.md (#2705)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
3 people authored Jan 13, 2024
1 parent 2725c02 commit 01fb44c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
8 changes: 8 additions & 0 deletions worlds_disabled/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,11 @@
This folder is for already merged worlds that are unmaintained and currently broken. If you are interested in fixing and
stepping up as maintainer for any of these worlds, please review the [world maintainer](/docs/world%20maintainer.md)
documentation.

## Information for Disabled Worlds

For each disabled world, a README file can be found detailing when the world was disabled and the reasons that it
was disabled. In order to be considered for reactivation, these concerns should be handled at a bare minimum. However,
each world may have additional issues that also need to be handled, such as deprecated API calls or missing components.


7 changes: 7 additions & 0 deletions worlds_disabled/oribf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
### Ori and the Blind Forest

This world was disabled for the following reasons:

* Missing client
* Unmaintained
* Outdated, fails tests as of Jun 29, 2023

0 comments on commit 01fb44c

Please sign in to comment.