scripts
scripts copied to clipboard
Improve the Scripts documentation
In my opinion the Scripts repository documentation needs some improvements:
- assign the
application.json,script.jsonandscript.jspages as subpages to a new page calledApplication Installers. This change makes it clearer that these files belong together and are required when writing an application installer - add either a badge or a direct link to the Scripts repository documentation to the README file
I don't know how to do the first bullet with Jekyll, @plata do you have an idea?
Not quite sure what you have in mind but you could simply add the new page to the menu and then link the 3 other pages from there. Syntax would be like: [Build]({{ site.baseurl }}{% link _docs/Developers/build.md %}
I basically want a navigation menu that looks like this:
- Welcome
- Develop
- Application Installers
- application.json
- script.json
- script.js
- Utils
- Verbs
- SetupWizard
- JSDoc
- Application Installers
- General
- Tools
- Translation
- Classes
- Best practices
I don't think that's easily possible. The relevant code is here: https://github.com/PhoenicisOrg/scripts/blob/662e0d434131403968dc407b38118e4e79ec922c/docs/_layouts/default.html#L49
So if you really want this, you would probably need some kind of sub-category field. Not sure it's really worth the effort (compared to only linking from the "Application Installers" page).