doc: misc improvements - WIP #1273
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
Cleaning up stale PRs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not done yet, but I thought I'd share because "shitty first draft"
Some thoughts already:
I added some content for first users in
usage.mdjust to get them off the ground.I think the emphasis on "functions" in the docs is a bit strange. But I can write code so I'm maybe not representative. I think it's better to say: commands contain code and then talk about what kinds of code you can write and what (modules, properties, methods) you can use.
More distinction between commands and command utilities is useful I think.
I think it's OK to be explicit with: "the code between the tags of a command is JavaScript code".
I think the name "JavaScript execution commands" is a bit awkward because interpolation commands also contain JavaScript and also execute. But that naming decision can't easily be undone. I do prefer "execution commands" over "JavaScript execution commands" because it's shorter. It also mirrors "interpolation commands" wrt name length and thus contrasts better with it.