Wiki page

[PCAssistSoftware]

As we have so many new areas to document (thanks to the great work by @RFBomb) I propose that I start creating several Wiki pages, this will allow the documentation to be more detailed with samples for usage in both C# and VB and in my opinion will be better than overloading the readme.md with information.

We can use this issue to discuss the pages I add so everyone involved can have some input on the content, and suggest any changes / improvements etc.

I will start work on this in the next few days.

[RFBomb]

Heres my thoughts on structure:

• ROboCommand should have its own page, along with all the options objects having their own pages.
• IRoboCommand should be on its own page.
• RoboQueue should have its own page.
• IProgressEstimator should have its own page, ProgressEstimator and RoboQueueProgressEstimator can be on the same page as IPRogressEstimator I think.
• IStatistic should have its own page, and Statistic should be below it.

Basically, Interface on top of page, then the primary objects that implement it below it. Other Interfaces, such as IResults can be standalone, since its implemented by multiple objects.

[RFBomb]

I can write up some of the interfaces descriptions in the coming weeks while I'm on the clock at work if you link me to where to edit them

[PCAssistSoftware]

I have started to add some blank pages based on your structure idea, never done GitHub Wiki before so just playing around with how to best do it.

I can write up some of the interfaces descriptions in the coming weeks while I'm on the clock at work if you link me to where to edit them

Think you will need @tjscience to give you permissions or you can type them up and email them to me and I will put them on for you?

[RFBomb]

I believe I can submit a PR against it, But if not I’ll post here

On Sun, Jan 16, 2022 at 6:09 PM Darren Rose @.***> wrote:

I have started to add some blank pages based on your structure idea, never done GitHub Wiki before so just playing around with how to best do it.

I can write up some of the interfaces descriptions in the coming weeks while I'm on the clock at work if you link me to where to edit them

Think you will need @tjscience https://github.com/tjscience to give you permissions or you can type them up and email them to me and I will put them on for you?

— Reply to this email directly, view it on GitHub https://github.com/tjscience/RoboSharp/issues/141#issuecomment-1013972099, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE34HF5HFHYWVJXW4GC6VFTUWNF2ZANCNFSM5MDE2Y7Q . You are receiving this because you were mentioned.Message ID: @.***>

[PCAssistSoftware]

I believe I can submit a PR against it, But if not I’ll post here

Okay cool, didn't realize you could do PR for Wiki - that's handy

Any other pages you want adding just let me know name and hierarchy

[RFBomb]

I've created https://github.com/tjscience/RoboSharp/wiki/IStatistic and updated the side bar organization, and filled out the links to all the pages.

You can use the IStatistic page for reference on proposed structure and how to do some formatting

[PCAssistSoftware]

Excellent, looking good - thanks for that, handy to have a page to see best way to do formatting

[RFBomb]

Alright, all the Interfaces have been finished on the wiki, except IROboCommand since thats ones large. The rest of the objects can come later. I submitted a PR to link to the wiki so the next nuget release has easily accessible ways for consumers to access it. I think I got the important ones all linked up.

[PCAssistSoftware]

Excellent work :)

I was planning to do a section with some code examples, such as those currently in Readme.md and some more - and will do them in both C# and VB - just useful bits for newbies coming to this project, for anything more complex they can read your full documentation and dissect the sample app to learn.

[RFBomb]

Yea thats all fine. I just wanted to give a base structure for the pages to look like and get the links all set up. If you could author the rest of the pages (its basically just copy pasting the stuff over from the code itself and doing the formatting), thatd be great.

[PCAssistSoftware]

Will see what I can do - am away for a few days now with work so may not be until I get back and caught up

[RFBomb]

No worries, like I said, I just wanted to get the basic setup complete