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

Improved instructions for new users adding scripts #415

Open
cv-on-hub opened this issue Jan 28, 2023 · 3 comments
Open

Improved instructions for new users adding scripts #415

cv-on-hub opened this issue Jan 28, 2023 · 3 comments
Labels
bug Something isn't working

Comments

@cv-on-hub
Copy link
Contributor

This should be a PR for changes to www.finalelua.com/help/install/script except I can't find where the source Docs page is located.

The current install/script instructions are confusing, and the thoughtful inclusion of all JW/RGP options makes it more complex than it needs to be. Attached below a suggestion for a simpler version recommending RGP alone (Mac-specific). Look forward to Review from @Nick-Mazuk. I realise that adding single scripts is common, but setting aside a dedicated folder other than inside the actual Plug-ins folder, feels the most versatile and easily understandable option.

Lua_Simple_Install

@cv-on-hub cv-on-hub added the bug Something isn't working label Jan 28, 2023
@Nick-Mazuk
Copy link
Member

The plugin and script install docs are currently hard-coded into the docs repo. Here's the file for the script install docs.

https://github.com/finale-lua/jw-lua-scripts-docs/blob/main/src/routes/help/install/script.svelte

Here's the actual lines of code for the instructions. If you know HTML, you can write raw HTML here.

https://github.com/finale-lua/jw-lua-scripts-docs/blob/7557fd969eac523db776264730995a58b91e3e15/src/routes/help/install/script.svelte#L37-L87

Given that (almost) no one should install JW Lua anymore, I'd be fine removing the JW Lua specific verbiage. I'd caution against making this macOS only, though, because we do have many Windows users.

At some point I should improve how the docs are generated. Especially as more people are becoming active and I'm less so.

@cv-on-hub
Copy link
Contributor Author

Here's my suggested re-wording. Should work for Mac/Win and any matching version of RGPLua. I've only changed wording in the Ordered List, leaving the boundary material alone.
script_cv.svelte.txt

@cv-on-hub
Copy link
Contributor Author

This has been raised as PR#28 under jw-lua-scripts-docs at finale-lua/jw-lua-scripts-docs#28

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants