MiSTer Wiki Discussion

The Wiki is a source of knowledge for the MiSTer project, contributions are welcome.
Xbytez
Posts: 392
Joined: Wed May 20, 2020 3:36 pm
Has thanked: 173 times
Been thanked: 657 times

MiSTer Wiki Discussion

Unread post by Xbytez »

This forum is for discussion about the MiSTer Wiki which is located here: https://github.com/MiSTer-devel/Main_MiSTer/wiki
N.Master
Posts: 19
Joined: Wed Oct 13, 2021 11:47 am
Has thanked: 6 times
Been thanked: 5 times

Re: MiSTer Wiki Discussion

Unread post by 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
Posts: 392
Joined: Wed May 20, 2020 3:36 pm
Has thanked: 173 times
Been thanked: 657 times

Re: MiSTer Wiki Discussion

Unread post by Xbytez »

N.Master wrote: Thu Oct 21, 2021 7:05 am Is this topic for discussing about updates or corrections suggested to the wiki ?
It most certainly is :)
alanswx
Core Developer
Posts: 271
Joined: Sun May 24, 2020 6:55 pm
Has thanked: 5 times
Been thanked: 97 times

Re: MiSTer Wiki Discussion

Unread post by alanswx »

N.Master wrote: Thu Oct 21, 2021 7:05 am 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.
User avatar
venice
Posts: 668
Joined: Tue Jun 16, 2020 9:29 am
Location: Germany
Has thanked: 228 times
Been thanked: 229 times

Re: MiSTer Wiki Discussion

Unread post by 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.
My MiSTer Display-Add-On-Projects on Github tty2oled, i2c2oled
Donate via Postcard-Ware if you like.
User avatar
venice
Posts: 668
Joined: Tue Jun 16, 2020 9:29 am
Location: Germany
Has thanked: 228 times
Been thanked: 229 times

Re: MiSTer Wiki Discussion

Unread post by 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?
My MiSTer Display-Add-On-Projects on Github tty2oled, i2c2oled
Donate via Postcard-Ware if you like.
User avatar
rbz
Posts: 16
Joined: Thu Nov 25, 2021 10:56 pm
Has thanked: 28 times
Been thanked: 17 times

Re: MiSTer Wiki Discussion

Unread post by 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
Posts: 1092
Joined: Mon May 25, 2020 7:54 pm
Has thanked: 329 times
Been thanked: 303 times

Re: MiSTer Wiki Discussion

Unread post by akeley »

Anybody with a github account can make changes to the wiki and add new pages.
User avatar
venice
Posts: 668
Joined: Tue Jun 16, 2020 9:29 am
Location: Germany
Has thanked: 228 times
Been thanked: 229 times

Re: MiSTer Wiki Discussion

Unread post by venice »

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

I will look for aberu's Documentation Sites as well.
My MiSTer Display-Add-On-Projects on Github tty2oled, i2c2oled
Donate via Postcard-Ware if you like.
Post Reply