openETCS / toolchain

WP7: Top Level Project for the toolchain
27 stars 30 forks source link

Integrate SysML to B documentation into openETCS tool chain doc #463

Closed MERCEmentre closed 9 years ago

MERCEmentre commented 9 years ago

We should integrate documentation available at https://github.com/openETCS/toolchain/tree/master/ToolDescription/MERCE-SysML-to-B into official openETCS toolchain doc made at https://github.com/openETCS/toolchain/wiki/Documentation .

Question for @idelatorre : the documentation is quite long. Should we create chapters in existing doc (at https://github.com/openETCS/toolchain/wiki/User-Documentation#TODO_SysML_to_B_transformation I guess) or create a new top level doc that would be referenced in the tool chain?

2nd question for @idelatorre : am I correct that I only need to create pages on the wiki (under Documentation) to have it integrated into tool chain documentation? Any other things to do?

idelatorre commented 9 years ago

there are 2 opstions to proceed:

If you create a page under documentation this page will be in mediawiki format but take into account that this page will be located as a new section, not under user documention section into the Eclipse Help

idelatorre commented 9 years ago

@MERCEmentre do you have more questions?. Do you have some info available?

MERCEmentre commented 9 years ago

Hello @idelatorre ,

Currently no more question. I plan to use option 1 (integrate in existing chapter). I just need some time to reformat our current Word doc into Mediawiki format.

Best regards, david

idelatorre commented 9 years ago

This issue was duplicated. See #440