VSpaceCode / vspacecode.github.io

VSpaceCode website
https://vspacecode.github.io
3 stars 23 forks source link

Documentation writing #49

Closed mly32 closed 3 years ago

mly32 commented 3 years ago

This PR updates the writing of the which-key documentation.

A few points that require further discussion:

MarcoIeni commented 3 years ago

To me which-key is fine, but it's up to Steven, of course :)

some properties in the writing make more sense to have a code block around them. For example, whichkey.show. there were words that did not have a backtick block around them, that should/could have them. I did not touch those. I can go back and add them if necessary.

Can you do it in a separate pr?

stevenguh commented 3 years ago

Thank you for cleaning up the doc :)

  • which key is written out many ways in this documentation and there should be some uniformity. Some variations I saw were: "which-key", "which key", "whichkey", "Which Key". What is the preferred name?

To me which-key is fine, but it's up to Steven, of course :)

I don't have a strong preference, the suggestion from Marco seem reasonable.

  • the code blocks use json and jsonc. I changed the code blocks to use jsonc for consistency. If this is unwanted, please let me know.

I think I put jsonc because some block contains some comments. Either way is fine :)

  • some properties in the writing make more sense to have a code block around them. For example, whichkey.show. there were words that did not have a backtick block around them, that should/could have them. I did not touch those. I can go back and add them if necessary.

The example you gave makes sense to have backtick around them. It would be awesome if you can do a follow up.

  • the word side bar is spelled in two words, but I believe it should be one word.

vscode have it as two words, so we should probably use it to be consistent.

image
stevenguh commented 3 years ago

Unified the wording of side bar in 83ced0f3107b62e6d61e3bd93eb75ae4311e9877.