From 01fb44c186e9d1157b0a1be932d99f21b39ba3bf Mon Sep 17 00:00:00 2001 From: Nicholas Saylor <79181893+nicholassaylor@users.noreply.github.com> Date: Sat, 13 Jan 2024 15:10:16 -0500 Subject: [PATCH] Docs: Added Disabled World information to README.md (#2705) * Add rationale for OriBF being disabled * Removed periods * Added warning to README.md * Apply suggestions from code review Co-authored-by: Silvris <58583688+Silvris@users.noreply.github.com> * 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 <59490463+black-sliver@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> --------- Co-authored-by: Silvris <58583688+Silvris@users.noreply.github.com> Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com> --- worlds_disabled/README.md | 8 ++++++++ worlds_disabled/oribf/README.md | 7 +++++++ 2 files changed, 15 insertions(+) create mode 100644 worlds_disabled/oribf/README.md diff --git a/worlds_disabled/README.md b/worlds_disabled/README.md index b891bc71d4ba..a7bffe222b14 100644 --- a/worlds_disabled/README.md +++ b/worlds_disabled/README.md @@ -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. + + diff --git a/worlds_disabled/oribf/README.md b/worlds_disabled/oribf/README.md new file mode 100644 index 000000000000..0c78c23bea0d --- /dev/null +++ b/worlds_disabled/oribf/README.md @@ -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