Wiki Structure Suggestion

Hi,

I'd suggest putting toolchain setup etc. into wiki pages like: FAMILY:-arm, FAMILY:-msp etc.

If BOARDS:-msba2 points to FAMILY:-arm and RIOT-Platforms points to both the family and the board, then I think this information is on the best of all possible paths.

The current getting started pages (https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-compiling-riot) would then refer to the RIOT-Platforms page for this kind of information.

Any thoughts on this?

Cheers, Ludwig

Hi Ludwig,

I'd suggest putting toolchain setup etc. into wiki pages like: FAMILY:-arm, FAMILY:-msp etc.

If BOARDS:-msba2 points to FAMILY:-arm and RIOT-Platforms points to both the family and the board, then I think this information is on the best of all possible paths.

I think having a collection of information about the different toolchains on separate pages is a very good idea. However, I think I haven't completely understood how you envision the concrete implementation. Could you provide a sample wiki page of your idea?

The current getting started pages (Introduction · RIOT-OS/RIOT Wiki · GitHub) would then refer to the RIOT-Platforms page for this kind of information.

That would definitely help to make this page much neater.

Any thoughts on this?

We should also include information about which toolchain and version is known to work well with which platform and feature and which is known to cause trouble.

Cheers, Oleg

Hauke started already and I jumped in: https://github.com/RIOT-OS/RIOT/wiki/Board:-msba2 https://github.com/RIOT-OS/RIOT/wiki/Board:-native

These list which toolchains are supported for each board.

The idea is to have (move) information about toolchain setup on (to) Family pages as this should be equal for most boards.

If a specific board has oddities, the respective board page can reflect that.

Cheers, Ludwig

Hi Ludwig!

Hauke started already and I jumped in: Create new page · RIOT-OS/RIOT Wiki · GitHub Create new page · RIOT-OS/RIOT Wiki · GitHub

These list which toolchains are supported for each board.

The idea is to have (move) information about toolchain setup on (to) Family pages as this should be equal for most boards.

If a specific board has oddities, the respective board page can reflect that.

Ah, I see. I haven't seen the above mention pages before.

+1

Cheers, Oleg

Hej hej,

I further created a page for the STM32F3dicovery ( ) on the plane on Friday. It has a slightly different structure, but I think it would go together well with Ludwigs idea of creating separate Wiki pages for toolchains, which could in fact just be referenced to from the board-pages. cheers, Hauke

OK, now https://github.com/RIOT-OS/RIOT/wiki/RIOT-Platforms and https://github.com/RIOT-OS/RIOT/wiki/Introduction#wiki-platforms-based-on-arm as well as https://github.com/RIOT-OS/RIOT/wiki/Board:-MSBA2 and https://github.com/RIOT-OS/RIOT/wiki/Board:-STM32F3discovery point to: https://github.com/RIOT-OS/RIOT/wiki/Family:-ARM

Cheers, Ludwig

Hauke started already and I jumped in: Create new page · RIOT-OS/RIOT Wiki · GitHub Create new page · RIOT-OS/RIOT Wiki · GitHub

I further created a page for the STM32F3dicovery ( Create new page · RIOT-OS/RIOT Wiki · GitHub) on the plane on Friday. It has a slightly different structure, but I think it would go together well with Ludwigs idea of creating separate Wiki pages for toolchains, which could in fact just be referenced to from the board-pages.

OK, now RIOT Platforms · RIOT-OS/RIOT Wiki · GitHub and Introduction · RIOT-OS/RIOT Wiki · GitHub as well as Create new page · RIOT-OS/RIOT Wiki · GitHub and Create new page · RIOT-OS/RIOT Wiki · GitHub point to: Family: ARM · RIOT-OS/RIOT Wiki · GitHub

Looks good to me, just one issue: ARM7 is not equal to ARM Cortex, there are different issues and not all Arm toolchains work for both architectures... But I guess we just need to differentiate a little better here...

cheers, Hauke

I just took what information was there... go ahead, split and/or rename.

Cheers, Ludwig