Skip to content
This repository was archived by the owner on May 22, 2020. It is now read-only.
This repository was archived by the owner on May 22, 2020. It is now read-only.

Finish documentation #1

@crbelaus

Description

@crbelaus

We must finish Frankt documentation before publishing the first version.

  • Finish Readme
  • Update Elixir modules documentation
    • Document public functions
    • Document errors
    • Document behaviours
    • Provide some examples
    • Provide typespecs
  • Manual
    • Concepts: Frankt channels, action handlers, error handlers, Frankt plugs, etc.
    • Recommendations
    • Examples/Guides
      • Using the default Frankt actions (may be covered with the example application that is being built in Add integration test #11)
      • Sending serialized data from a data-attribute
      • Configuring a Frankt channel with Gettext
      • Configuring a Frankt channel with custom plugs
      • Creating a custom error handler in a Frankt channel
      • Sending data in Frankt actions (form data, element name/value and data-attributes)
      • Creating new Frankt actions to extend the default ones
      • Working with CSRF token protection

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions