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

SoE: Docs: rework some styling #3268

Merged
merged 2 commits into from
May 6, 2024

Conversation

black-sliver
Copy link
Member

@black-sliver black-sliver commented May 4, 2024

What is this fixing or adding?

As was mentioned in SoE Channel on Discord:

  • "Connect to SNI" section is actually wrong(ly ordered, and has wrong header levels inside)
  • "Required software" was not 100% correct because it expected people to have a modern web browser, and in fact Archipelago install is optional for SoE.

Other suggestions from Discord discussion would affect the global style and would have to be handled there - those were changing the margin and/or padding around ol and/or h3 as well as making h3, h4 and h5 easier to distinguish.

(For completeness sake, I reject the alternative suggestion to change h5 into ul, because massive nested lists are even harder to parse imo.)

How was this tested?

👀

@github-actions github-actions bot added the is: documentation Improvements or additions to documentation. label May 4, 2024
@black-sliver black-sliver changed the title Soe docs rework SoE: Docs: rework some styling May 4, 2024
@github-actions github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label May 4, 2024
Copy link
Member

@Exempt-Medic Exempt-Medic left a comment

Choose a reason for hiding this comment

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

LGTM. The headers depths make sense now, even if there are a lot of them which isn't great, but changing them is out of scope

@black-sliver black-sliver added waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer. and removed waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. labels May 5, 2024
@NewSoupVi NewSoupVi merged commit 23eca7d into ArchipelagoMW:main May 6, 2024
10 checks passed
@black-sliver black-sliver deleted the soe-docs-rework branch May 19, 2024 13:35
jnschurig pushed a commit to Tranquilite0/Archipelago-SoulBlazer that referenced this pull request Jun 13, 2024
* Docs: SoE: move header and fix header level

* Docs: SoE: be pedantic for required software
qwint pushed a commit to qwint/Archipelago that referenced this pull request Jun 24, 2024
* Docs: SoE: move header and fix header level

* Docs: SoE: be pedantic for required software
AustinSumigray pushed a commit to AustinSumigray/Archipelago that referenced this pull request Jan 4, 2025
* Docs: SoE: move header and fix header level

* Docs: SoE: be pedantic for required software
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
is: documentation Improvements or additions to documentation. waiting-on: core-review Issue/PR has been peer-reviewed and is ready to be merged or needs input from a core maintainer.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants