PLEASE put the docs in a documentation site. The API and Guide docs are way too long!

[Oneechan69]

It's very jarring to go through the guides as one long document with no table of contents (which GitHub currently doesn't support outside of the main readme file).

[JosXa]

I read it in one sitting and tried out the examples, had a good experience. Agreed having a separate docs site would be nice, but I'm sure John has more important things to do ^^

[alexilyaev]

The docs seem to be scattered around in 4 different files:

• API.md
• GUIDE.md
• KIT.md
• TIPS.md

It is indeed hard to find specific things.

e.g.

• What are all the possible script metadata settings and how to use them?
  • Right now there's no easy way to find out, and some of them are missing
• What are all of the globally available commands?
  • It's somewhat discoverable through TypeScript, but then hard to find out how to use them or even just a link to the underlying library that they delegate to

[JosXa]

@alexilyaev I got to work putting those files in a docusaurus, looks pretty good but needs some more styling and final approval from John to go live anywhere.

I learned that you can nicely search those 4 markdown files in Kit itself, just type docs followed by a space. Since I learned about that, I almost don't miss a docs website anymore.

[YousufSSyed]

@JosXa Where can I see the documentation

[alexilyaev]

@JosXa That's nice, but not a solution in my opinion. Example... there's a paste() method we can use. Searching it in Kit > Docs > "paste" yields nothing:

Same thing with setSelectedText():

Once there's a centralized place for docs, we can start filling in the missing pieces. Right now you it's not even clear where to put these.