GithubHelp home page GithubHelp logo

inkdropapp / api-docs Goto Github PK

View Code? Open in Web Editor NEW
16.0 16.0 5.0 25.17 MB

API documentation for Inkdrop

Home Page: https://developers.inkdrop.app/

License: Other

JavaScript 28.42% MDX 71.44% CSS 0.14%

api-docs's People

Contributors

craftzdog avatar keisir avatar mayuben1027 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

api-docs's Issues

Categories redesign

Hi everyone,
as the API documentation is being updated, I would like to take the opportunity to propose a revision of the categories.

Currently there is one big category "Essential Classes" which contains pretty much all classes you need for plugin development (well, the name suggests it ๐Ÿ˜„). Currently it looks like the categorization will continue under a new name "Core Modules".
Personally, I don't find this very intuitive and I didn't find my way around very quickly in the beginning.

So I would suggest to rethink and split the categories. For example, the pages for the "event-kit" library ("Composite Disposable", "Disposable" and "Emitter") could be moved to a separate section. This would allow for a clearer distinction. The same could be done with "Environment", etc.

If this suggestion meets with approval, I can create a proposal as a PR so we can discuss the details.

@craftzdog, what do you think? Is this something you would like to see in the documentation?

Wrong redirection

Hey,
While looking at this documentation I noticed a bug that redirects you to a different page twice.

Info:
The error occurs on Windows with Google Chrome or Firefox. No browser extensions are installed.

Steps to reproduce the bug:

  1. click on a link, it doesn't matter if it is an external web page or a page of this documentation.
  2. after opening the page, use the back button to return to the previous page.
  3. within a few seconds you will be redirected to the page you navigated back from.

wrong-redirection

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.