Sitelet https://github.com/KrailOrg/krail/blob/develop/docs/index.rst
Skip to content

Latest commit

 

History

History
95 lines (70 loc) · 2.4 KB

File metadata and controls

95 lines (70 loc) · 2.4 KB

Krail documentation

This documentation is in 3 parts

  • :doc:`Tutorial. <tutorial/tutorial-intro>` As you would expect, this is a step by step tutorial.
  • :doc:`User Guide. <userguide/userguide-intro>` Notes on how to do things, collated by feature
  • :doc:`Developer Guide. <devguide/devguide-introduction>` Notes on why things are done the way they are. In truth, this is really a loose collection of technical notes optimistically called a "developer guide"

Please do give feedback, whether it is something you do like or something you do not like.

Enjoy

David Sowerby

Contents:

.. toctree::
   :maxdepth: 3
   :caption: Tutorial

   tutorial/tutorial-intro
   tutorial/tutorial-getting-started
   tutorial/tutorial-pages-navigation
   tutorial/tutorial-ui-theme
   tutorial/tutorial-user-notification
   tutorial/tutorial-options
   tutorial/tutorial-configuration-from-ini
   tutorial/tutorial-uac
   tutorial/tutorial-i18n
   tutorial/tutorial-i18n-components-validation
   tutorial/tutorial-persistence-jpa
   tutorial/tutorial-guice-scopes
   tutorial/tutorial-event-bus
   tutorial/tutorial-services
   tutorial/tutorial-push
   tutorial/tutorial-eclipse
   tutorial/tutorial-create-hierarchy
   tutorial/tutorial-functional-test



.. toctree::
   :maxdepth: 3
   :caption: User Guide

   userguide/userguide-intro
   userguide/userguide-bootstrap
   userguide/userguide-injector-scope
   userguide/userguide-serialisation
   userguide/userguide-form
   userguide/license



.. toctree::
   :maxdepth: 3
   :caption: Developer Guide

   devguide/devguide-introduction
   devguide/devguide-goals
   devguide/devguide-bootstrap
   devguide/devguide-configuration-overview
   devguide/devguide-eventbus
   devguide/devguide-functional-test
   devguide/devguide-guice-scopes
   devguide/devguide-i18n
   devguide/devguide-options-hierarchies
   devguide/devguide-pages-navigation
   devguide/devguide-push
   devguide/devguide-persistence
   devguide/devguide-serialisation
   devguide/devguide-services
   devguide/devguide-testing
   devguide/devguide-uac
   devguide/devguide-validation
   devguide/devguide-vertx
   devguide/license

.. toctree::
   :maxdepth: 3
   :caption: Glossary

   glossary