Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
PWagner1 opened this issue Jul 3, 2024 · 4 comments
Labels
discussion Discussion thread. enhancement New feature or request new feature A new feature has been requested. suggestion A suggestion has been requested.

Comments

@PWagner1
Copy link
Contributor

PWagner1 commented Jul 3, 2024

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?

@PWagner1 PWagner1 added enhancement New feature or request discussion Discussion thread. new feature A new feature has been requested. suggestion A suggestion has been requested. labels Jul 3, 2024
@giduac
Copy link

giduac commented Jul 3, 2024

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
Copy link
Member

Smurf-IV commented Jul 3, 2024

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
Copy link

giduac commented Jul 3, 2024

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....

@PWagner1
Copy link
Contributor Author

PWagner1 commented Jul 3, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Discussion thread. enhancement New feature or request new feature A new feature has been requested. suggestion A suggestion has been requested.
Projects
None yet
Development

No branches or pull requests

3 participants