Git Product home page Git Product logo

documentation's Introduction

NPM Version Gitter

Qooxdoo JavaScript Framework

qooxdoo is a universal JavaScript framework that enables you to create applications for a wide range of platforms. With its object-oriented programming model you build rich, interactive applications (RIAs), native-like apps for mobile devices, light-weight traditional web applications or even applications to run outside the browser.

You leverage its integrated tool chain to develop and deploy applications of any scale, while taking advantage of modern web technologies like HTML5 and CSS3, its comprehensive feature set and a state-of-the-art GUI toolkit. qooxdoo is open source under liberal licenses, led by a dedicated developer team, with a vibrant community.

For more information please see http://qooxdoo.org .

License

qooxdoo may be used under the terms of the MIT License.

Quick start

It is easy to get started with qooxdoo. For detailed information please see our Get Started Guide.

Documentation

API Ref

Development

If you develop with qooxdoo, you would normally use a stable NPM release, which, since v6.0.0, contains the compiler and the CLI called with with npx qx <command>.

In contrast, if you want to be hacking qooxdoo itself, please refer to our documentation.

Contributing

There are many ways you can contribute to qooxdoo, ranging from providing feedback, making translations, providing a custom library to full-blown patches to the code. Please check our web site for details. Mind that for every patch to the repository we require an open bug in our issue tracker, and that commits to the repository will fall under qooxdoo's license terms.

Qooxdoo source code is hosted on github/qooxdoo and we use the standard Issue Tracker and Pull Requests feature.

Community

Online chat is available via Gitter at https://gitter.im/qooxdoo/qooxdoo (or using one of the Gitter desktop or mobile clients) - the core team hang out there, as do other developers who use Qooxdoo.

Learn more

documentation's People

Contributors

cboulanger avatar derrell avatar hkollmann avatar isparks avatar johnspackman avatar rad-pat avatar rommni avatar voger avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

Object Id documentation

We need a page which explains the philosophy and design of the object id system and provides a few examples how to use it. Assigning @johnspackman since you devised the system.

Remove apps:// pseudo-protocol?

There were two ideas behind introducing the apps:// pseudo-protocol to indicate links to the qooxdoo apps:

  • it made it possible to have local versions of the qooxdoo apps that could be linked to in the documentation. Docsify would dynamically reference the online or offline version dependent on whether it was run with qx serve or from the qooxdoo domain. However, we no longer ship the offline apps with the NPM release-
  • it would speed up linting as the links were considered to be safe. However, the links can be faulty if the apps change something in their approach to routing (which would be bad, because non-BC) or if there is something broken. The question is if the increase in speed is more valuable than alerting us to broken links.

I suggest we replace apps:// with real https:// links. This would also make them work when viewing the docs on GitHub. It would still be possible to implement some kind of dynamic redirection if we need it, based on those links.

Documentation versioning

With the switch to sematic release, it becomes important to have a system that automatically creates documentation that reflects feature and breaking releases:

  • No feature and breaking release should be done without a corresponding update and release of the documentation .
  • qooxdoo.org/documentation should always have the latest version, qooxdoo.org/documentation/X.X the corresponding legacy docs.

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.