There have been many questions both in issues and PRs that could have been addressed with some existing as-yet unmigrated documentation. (Not all questions, but a significant number.) People are curious, that's great.
Note that this is not MSDN-style API documentation, but more ad hoc documents. I believe there is a shared understanding that documents like this, not MSDN-style docs but the more ad hoc docs, should be checked in next to the code. Let me know if not.
This will not be a straight copy job though and should be done with due care, for the following reasons:
- some docs refer to the prior internal name for ML.NET (though to be fair I've noticed the code does too in places 😛) so that ought to be changed,
- it appeals to historical perspectives or prior states of code that are invisible to people, which is awkward. This is hard, you can't just delete that stuff, because the point of the code docs is to explain exactly why something is engineered in a certain way, and that discussion is helped enormously if you explain why a deceptively "easier" way of doing task X, Y, or Z was deemed unacceptable.
- it sometimes contextualizes the presence of this or that aspect of the code as being something that exists to solve an existing use-case, and not all those use-cases are open sourced.
- While much of it is already in
.md, some older docs are in other formats and will require some attention to migrate them.
Would appreciate discussion from @asthana86 , @eerhardt , @GalOshri , @glebuk , and @shauheen specifically on this topic. (To clarify all are welcome, just mentioning to make sure it gets flagged for them. 😄)
There have been many questions both in issues and PRs that could have been addressed with some existing as-yet unmigrated documentation. (Not all questions, but a significant number.) People are curious, that's great.
Note that this is not MSDN-style API documentation, but more ad hoc documents. I believe there is a shared understanding that documents like this, not MSDN-style docs but the more ad hoc docs, should be checked in next to the code. Let me know if not.
This will not be a straight copy job though and should be done with due care, for the following reasons:
.md, some older docs are in other formats and will require some attention to migrate them.Would appreciate discussion from @asthana86 , @eerhardt , @GalOshri , @glebuk , and @shauheen specifically on this topic. (To clarify all are welcome, just mentioning to make sure it gets flagged for them. 😄)