mpf-docs
mpf-docs copied to clipboard
missionpinball
Formatting errors in docs: main status tracker
We recently migrated the mpf-docs repo from Sphinx docs to MKdocs. (details here)This involved converting all the pages from RST to MD, and we used some tools and customs scripts to do this. But some sections of some docs got mangled. If you find any messed up formatting or weird sections, please reply to this thread with the example and link and we'll get it fixed. Thanks!
Okay, here we go with number 1
https://missionpinball.org/hardware/opp/cobrapin/
Here right at the top in "Features" the itemizing bullet points are screwed up.
Would that level of information be sufficient? In addition I can of course fix it manually, but maybe you find more occurrences and can fix them all in one go. If I should fix this (or future issues I am going to report) manually just let me know and I'll do it.
And number 2, same link
https://missionpinball.org/hardware/opp/cobrapin/
in "Power an Filters" the J9, J10 and so on should be in bold and the ":" should not be there in the first line after the bold print.
And number 3, same link
https://missionpinball.org/hardware/opp/cobrapin/
in section "Test Rig" the table is completely messed up.
Number 4 in
https://missionpinball.org/mechs/lights/
see the names of the links before the embedded picture. The linked target seems to be good, but the name of the link is wrong.
Number 5 same link
https://missionpinball.org/mechs/lights/
all the config file examples below the embedded picture are messed up.
number 6 a minor one
https://missionpinball.org/mechs/lights/flashers/
The table at the top is now a bullet list.
number 7
https://missionpinball.org/mechs/lights/flashers/
under the headline "Hardware" the first text should not be in that font size and bold, it should be normal text.
Thanks for all these examples! I think I'll have some time this weekend to investigate and see if they are systemic or just random examples. Keep the examples coming, even if I can't get to it this weekend, it's great to have them all in one place.
I cloned the repro and running the server with the docs locally throws hundreds of message because of absolute links. From my point of view all these messages might make it hard to see real issues. Most of these links are inside the includes. Is there something we can do about it? Just changing them to relative links might break it. Do we need the includes, makes it live really that much easier?
Found another bug after the new setup https://missionpinball.org/game_logic/modes/ At the very bottom the list of build in modes is missing.
Hi, another issue here https://missionpinball.org/install/linux/ not sure if that is due to the migration or if someone tried to update it and didn't finish it.
Hi, I have another one and not sure how to fix it even manually. Maybe you can give some advise. It is about the event reference.
Every (!) entry shows something like this as header
title: ball_save(name)_enabled ball_save(name)_enabled
a) not sure what the title structure is good for, in other md files it is not being rendered as html b) The link to the main page doesn't seem to make much sense (2nd line)
Then the event ball_save(name)_timer_start is being listed twice once for normal ball save once for multiball. Is that really intended like this? If they both post the same event, it should only be listed once, if events are different then this needs to be fixed.
c) What is the right answer to this specific event?
I have added an event player_score which was missing, see pull request from today. I have added it to the list on the index.md file as well, but at list for mkdocs it doesn't show up on the left navigation frame.
d) What do I have to do to add it to the left navigation frame?