search

janfeitsma / MRA-prototype

MRA (Robocup MSL Reference Architecture) prototype
MIT License
5 stars 0 forks source link

MSL design documentation in archive #20

Open jveijck opened 1 year ago

jveijck commented 1 year ago

In the prototype phase documentation is created about the design and concepts of MSL. This is currently in a private archive. The files are written in ascii-doc. It is better to make a directory documentation in repro where these are stored. Alternative is a second public archive.

Discuss before adding it to the repro.

jveijck commented 1 year ago

Discussion: I would like to make the documentation public available. There are at least two options. Make the documentation part of the MRA-components repro on the MSL GIthub. Or make a second MRA repo on the MSL GitHub. This could be named: MRA-design

janfeitsma commented 1 year ago

Maybe the document repository could be generalized beyond MRA, for the MSL in general.

I'd like a central place for all the documents: TDP's, presentations from scientific challenges, MSL-workshop, material from our MRA discord calls -- organize it all a bit. (Not per se in a github repo.)

We could ask TC how they see this?

jveijck commented 1 year ago

A generated PDF could be part of a central storage. Most could be links to existing sources on the internet. I would not like to mix non MRA into the MRA-documents archive. The reason to make put it in the archive is that more people can contribute to it. And because it is asciidoc (a standard which is similar to Markdown) it can be viewed in several IDEs. And the latest version would be available as browsable document in the repro.

janfeitsma commented 1 year ago

Agree with not having PDF in the repo, only source (asciidoc). Maybe a pipeline could be made to produce and provide PDF.

I like your proposal MRA-design. But I think it is too early. Keep in mind after all that happened this year, it still is just you and me Jurge :D........ So let other devs connect first, get some experience and more voices in the discussion.

For now I'd just add something like a docs/ folder at base. Also we need to see how it goes, if there are potential consistency issues.