Giter VIP home page Giter VIP logo

Comments (5)

JosXa avatar JosXa commented on August 17, 2024

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 ^^

from kit.

alexilyaev avatar alexilyaev commented on August 17, 2024

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

from kit.

JosXa avatar JosXa commented on August 17, 2024

@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.

from kit.

YousufSSyed avatar YousufSSyed commented on August 17, 2024

@JosXa Where can I see the documentation

from kit.

alexilyaev avatar alexilyaev commented on August 17, 2024

@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:
image

Same thing with setSelectedText():
image

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.

from kit.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.