[EPIC] Documentation improvements

[jspelletier]

• Pick a tool for the documentation.
• Simple example that covers the basics. Main, Solution, Project, Config, Target, Options.
• Document Project class.
• Document Project Configuration.
• Document Solution class.
• Document Solution Configuration.
• Document Target class.
• Document other sharpmake includes.
• Document Platform extension (NDA Platforms info)
• Document use of FastBuild
• Advanced example which includes more than one build system, platform, using FastBuild etc.
• Document Options.
• Document Global Options.
• Document other Generators like JsonCompileCommands

[jspelletier]

All doc should be using markdown file format. I don't care what tool is used to create them

[defaultactor]

the openusd docs look pretty good https://github.com/PixarAnimationStudios/OpenUSD/blob/dev/docs/README.md

[Sharlock93]

I think at least for me, I'm going to just use the raw markdown and no tools. I was only considering docfx that generated the markdown from all the sharpmake code. That generation needs to be done once in a while when an API/Interface changes.

For now I think we can mark the first task done for the tool.
I have made a temp repo on my own account (https://github.com/Sharlock93/Sharpmake-Docs) for the initial draft.

The repo now contains all the generated code for the Sharpmake and Sharpmake.Generator projects, this is under api.

Last couple of weeks have been exceptionally busy at work as I'm trying to hit a milestone hence the slow work. Hopefully the rate will increase as I get more into the flow.

[jspelletier]

I was expecting a MR with modifications in docs folder. not a new repo.

[Sharlock93]

I was expecting a MR with modifications in docs folder. not a new repo.

Yes, ultimately I will merge it in into the docs. I just wanted to put it in a temp repo so it doesn't touch anything else just yet.

[defaultactor]

any progress on this?

[Sharlock93]

any progress on this?

Hey, I have written some more of this docs that is local on my machine but its not much. The free time I had has been now taken up quite a bit. I have been hoping to get back to this for a while as I have been helping some people in the background with Sharpmake work.
Really sorry about the delay. I will try to at least get the initial stuff finished in the next couple of weeks.