airline icon indicating copy to clipboard operation
airline copied to clipboard

Provide an Airline user guide

Open rvesse opened this issue 9 years ago • 3 comments

Currently Airline is fairly esoteric with no real user guide to teach people how to use the library

We should use GitHub pages and Jekyll to start putting together such a user guide

Content to create:

  • [x] Core Annotations
    • [x] @Cli
    • [x] @Command
    • [x] @Groups and @Group
    • [x] @Parser and @Alias
      • [x] New force built in feature
      • [x] resource locators for user aliases
    • [x] @Option
    • [x] @Arguments
  • [x] Restrictions
    • [x] Range Restriction Annotations
    • [x] @Partials
    • [x] Global Restriction
    • [x] Custom restrictions
    • [x] Annotations from #73
      • [x] @PortRange and @PortRanges
      • [x] @StartsWith
      • [x] @EndsWith
      • [x] @File and @Directory
      • [x] @Positive and @Negative
      • [x] @LengthRange and @ExactLength
  • [x] Help System
    • [x] Custom help sections
    • [x] Hints
    • [x] Formats
    • [x] Bash Completion
  • [x] Error Handling
  • [x] Parser
    • [x] Various new features introduced to @Parser
    • [x] Option Parsing
    • [x] User Defined Aliases
    • [x] Resource Locators
      • [ ] Custom Resource Locators
  • [ ] Unit Testing
  • [x] Maven Plugin
    • [x] validate goal
    • [x] generate goal
  • [ ] Fluent API
    • [ ] CliBuilder
    • [ ] ParserBuilder

rvesse avatar Nov 26 '15 12:11 rvesse

Early stub is up at http://rvesse.github.io/airline/ though it is a long ways off of being complete

rvesse avatar Dec 01 '15 14:12 rvesse

Lots more progress on this today though still lots to document

rvesse avatar Jan 19 '16 16:01 rvesse

Several recent commits have made some more progress on this

rvesse avatar Apr 03 '18 16:04 rvesse