Jump to content

Topic on Talk:RESTBase/Installation

Which sections bullet points are applicable to

1
TiltedCerebellum (talkcontribs)

It is really unclear which sections of the page the bullet points are applicable to because the initial instruction appears at the top, then a bullet below the example. People read the top of the example, the do the changes, then read the bullet below (like this is not applicable unless...) and then they changed something they shouldn't have changed (because they were doing it in order and expect to be able to do it in order) and then it isn't exactly clear which section the bullet applies to... please but the bullets above the relevant example and below the instruction text. Then the bullets can have a colon at the end of each bullet statement to make it actually clear what they apply to.

Right now it is hard to decipher this page correctly so I'm doing it for someone else who found it to be hard to follow.

We don't skip the example, read below it, then look up to do the example... we read what's above the example (which is usually the instruction with any notes or bullet points below that), then look down at, then do the example.


Instead of:

Edit the config.yaml file in these parts:

(example)

  • You don't need to change anything nor worry about this section unless you run a private wiki (see question)

It would be a lot better if it said:

If you run a private wiki, edit the config.yaml file in these parts:

(private wiki example)


Also edit the following in the config.yaml (public or private wikis) to fill in these parts:

  • Relevant bullet above the example:

(example)

  • Relevant bullet above the example:

(example)