search

Krypton-Suite / Standard-Toolkit

An update to Component factory's krypton toolkit to support .NET Framework 4.6.2 - 4.8.1 to .NET 6 - 8
BSD 3-Clause "New" or "Revised" License
372 stars 56 forks source link

[Feature Request]: Allow the API reference to be built alongside the toolkit #1596

Open Wagnerp opened 5 days ago

Wagnerp commented 5 days ago

Currently, the API reference is built individually using https://github.com/Krypton-Suite/Help-Files. However, this takes unnecessary time. Proposal: to move the shfbproj files to here & use the csproj files as documentation sources.

Thoughts @Smurf-IV & @giduac?

giduac commented 5 days ago

Does it interfere with the local build processes when working on the repo? Has this been tested thoroughly? Can it wait until we have things under control?

Smurf-IV commented 5 days ago

Can it wait until we have things under control?

This is my vote, because there should be "no more API changes" until V90 is stable. So this "could" be a v100 feature, And

Does it interfere with the local build processes when working on the repo?

Including the files back into a PR will be just the same amount pf pain ??

giduac commented 5 days ago

Can it wait until we have things under control?

This is my vote, because there should be "no more API changes" until V90 is stable. So this "could" be a v100 feature, And

Does it interfere with the local build processes when working on the repo?

I'd rather see we'd put some time in with @Wagnerp and see what can be done to simplify the fine-tuning of themes overall, since there are a few tickets about themes. That would be beneficial to V90 and onward....

Wagnerp commented 5 days ago

Does it interfere with the local build processes when working on the repo?

The current build process is detailed here https://github.com/Krypton-Suite/Help-Files/tree/master

These can be built through VS as per normal.

Has this been tested thoroughly?

Any new shfbproj files will be disabled until the final release

Can it wait until we have things under control?

It can, I can test it on a new branch to see if it's viable

there should be "no more API changes" until V90 is stable.

This won't include any new API changes, since it can be built using the existing build chain. The output will be a chm file and/or website files in Bin\Documentation. Full details on how to build them can be detailed here: https://krypton-suite.github.io/Standard-Toolkit-Online-Help/Source/Help/Output/articles/Contributing.html