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

docs: create new schelp with the content of old html broken help files #304

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fmiramar
Copy link

Most part of the help files from the MCLDFFTUGens are HTML files located at a MCLDUGens/Help folder, which turns out to be missing documentation files by the IDE. I have created this schelp file with the contents of the HTML and put them on the correct help folder MCLDUGens/HelpSource.

@mossheim
Copy link
Contributor

thanks, can you delete the html file too?

@fmiramar
Copy link
Author

thanks, can you delete the html file too?

Sure, I am going to check for others MCLDFFTUGens that have broken help files and commit the changes all at once.

@dyfer
Copy link
Member

dyfer commented Jul 27, 2021

Hello @fmiramar
What's the status of this PR?

@fmiramar
Copy link
Author

fmiramar commented Aug 4, 2021

Hi @dyfer

after these considerations from Josh Parmenter should I continue to pull requests to this repo ?

@dyfer
Copy link
Member

dyfer commented Aug 4, 2021

Hi @fmiramar

My understanding is that the developers agree that sc3-plugins is not an ideal way to maintain 3rd-party plugins, but we currently don't have a full-fledged replacement ready.

IMO we should still maintain the plugins that are here if possible, providing bugfixes and updating documentation etc. We probably won't be accepting new plugins though (unless other devs think otherwise).

Eventually, once we have a system in place (a package manager that can distribute binary plugins for multiple platforms), my understanding is that we would split up sc3-plugins into smaller packages and transfer maintenance duties as appropriate. All that is to say, that any updates we make in the meantime would migrate to these new repositories. When that would happen is unknown at this point.

@dyfer
Copy link
Member

dyfer commented Aug 6, 2021

In other words, the updates to documentation, especially converting the HTML files, are definitely welcome :)

@fmiramar
Copy link
Author

fmiramar commented Aug 7, 2021

Sure! I will try to finish it ASAP

BTW I am organizing a list of documentation improvements/changes that IMO are interesting (main repo and plugins). What is the process for collaborating in this case? Should I first open an issue or should I pull requests straightforwardly ?

@dyfer
Copy link
Member

dyfer commented Aug 7, 2021

Should I first open an issue or should I pull requests straightforwardly ?

I think that depends on the scope of changes... If it's something like reorganizing multiple files, then opening an issue might be better first, so that you can get feedback from others before making actual changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Waiting for review response
Development

Successfully merging this pull request may close these issues.

5 participants