MiSTer Wiki Discussion
Re: MiSTer Wiki Discussion
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.
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.
-
- Core Developer
- Posts: 268
- Joined: Sun May 24, 2020 6:55 pm
- Has thanked: 5 times
- Been thanked: 95 times
Re: MiSTer Wiki Discussion
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.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.
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.