MiSTer Wiki Discussion

[Xbytez]

This forum is for discussion about the MiSTer Wiki which is located here: https://github.com/MiSTer-devel/Main_MiSTer/wiki

[N.Master]

Hi,
Is this topic for discussing about updates or corrections suggested to the wiki ?
(without the risk of being yelled "Just fix it yourself if you are not happy with it!")

A small remark : sometimes informations are spread across 2 (official) sources, and one of them is not up to date.

For example, I tried to build my SDRAM XDS v2.9 module.
I first went to the Hardware_MiSTer section, and found partial informations :
https://github.com/MiSTer-devel/Hardware_MiSTer
Then I went to the MiSTer wiki section, and found more detailed infos :
https://github.com/MiSTer-devel/Main_Mi ... DRAM-Board
Then I crawled the forum to grab other infos (capacitors position for example)

But finally I still needed to download Altium designer demo to check the footprint of some components

This is not a criticism of the wiki or the project. I worked on some electronic projects myself, and I know the pain to maintain documentations up to date. It is very time consuming.
But if you can at least regroup all informations in the same wiki, and mark "depreciated" or "not up to date" on old infos, it will probably be very helpfull for newcommers.

[Xbytez]

Is this topic for discussing about updates or corrections suggested to the wiki ?

It most certainly is

[alanswx]

Hi,
Is this topic for discussing about updates or corrections suggested to the wiki ?
(without the risk of being yelled "Just fix it yourself if you are not happy with it!")

A small remark : sometimes informations are spread across 2 (official) sources, and one of them is not up to date.

For example, I tried to build my SDRAM XDS v2.9 module.
I first went to the Hardware_MiSTer section, and found partial informations :
https://github.com/MiSTer-devel/Hardware_MiSTer
Then I went to the MiSTer wiki section, and found more detailed infos :
https://github.com/MiSTer-devel/Main_Mi ... DRAM-Board
Then I crawled the forum to grab other infos (capacitors position for example)

But finally I still needed to download Altium designer demo to check the footprint of some components

This is not a criticism of the wiki or the project. I worked on some electronic projects myself, and I know the pain to maintain documentations up to date. It is very time consuming.
But if you can at least regroup all informations in the same wiki, and mark "depreciated" or "not up to date" on old infos, it will probably be very helpfull for newcommers.

At one point I had created a list of components, I am sure it is hopelessly out of date now. Please go ahead and mark up the wiki. It definitely needs to be updated, or at least as you say have an * that says -- this is out of date.

I am trying to clean up the development pages. I think I documented every CONF_STR option. I am 90% done with hps_io, now working on the top level emu block.

[venice]

Is it worth to ask for a wiki entry showing and/or linking add-on projects like the display add-ons (tty2oled/tty2tft/i2c2oled/tty2epaper) or the mt32-pi.

Makes it easier to find them.

[venice]

As nobody complains, how can I add such a wiki entry?
Can I fork a wiki like a Github Project an send PR's?

[rbz]

I like the idea of a page to show unofficial / community supported add-on projects and can't think of why they shouldn't be added to the main wiki as long as they are clearly in a section specifying they are unofficial / community supported.

As far as contributing to the wiki, you might be able to just edit the wiki directly without the fork, I see the edit/save buttons.

Unfortunately GitHub's wiki implementation is a bit hard to use in the traditional fork/PR to original repo method, even though the wiki itself is its own git repo. I found this gist describing how it can be done https://gist.github.com/larrybotha/10650410 but it looks fairly annoying for the person doing the fork and the one doing the merge back since it doesn't support the traditional PR workflow.

@aberu has also been working on this docs site https://github.com/MiSTer-devel/MkDocs_MiSTer/ that is more Google search friendly which is just a traditional repo, so I would say its worth adding info over there as well

[akeley]

Anybody with a github account can make changes to the wiki and add new pages.

[venice]

The start is done
See https://github.com/MiSTer-devel/Main_Mi ... al-Add-Ons

I will look for aberu's Documentation Sites as well.