# Pocket Archive Road Map

The first goal is to build a working prototype, with all the basic functional
components, even if not entirely developed or only usable in a specific
development environment, to demonstrate the overall workflows and
functionality.

The second step is to produce a basic application, which is fully
functional and available for use by the intended audience.

## Prototype (alpha)

❏ = pending; ⚒ = in progress; ⎊ = blocked; ✓ = complete; ✖︎ = not implemented.

- ✓ Configuration + config parser
  - ✓ Application
  - ✓ Content model
    - ✓ Validation rules
- ✓ Submission module
  - ✓ SIP building
  - ✓ Metadata from LL
  - ✓ Brick structures
  - ✓ Structure inference
- ✓ HTML generator
  - ✓ Index
  - ✓ Resource
  - ✓ Static assets
- ✓ Non-HTML generators
  - ✓ RDF (turtle)
  - ✓ Transformers
  - ✓ JS search engine index
- ✓ CLI
  - ✓ Init archive
  - ✓ Deposit
  - ✓ Generate site
  - ✓ Generate LL (single resource)
  - ✓ Generate RDF (single resource)
- ✓ Front end
  - ✓ JS search engine
  - ✓ Add collections to index page
  - ✓ Basic styling
      - ✓ Default type icons
- ✓ QA
  - ✓ ~50 resource data set

## Basic application (beta -> v1.0)

- ✖︎ Management UI & API
  - ✖︎ Deposit via single tar or zip file submission
- ⚒ Deposit via local hot folder
  - ❏ Option to clean up sources & LL on success
- ⚒ Proper collection handling
  - ✓ Dedicated template
  - ✓ Link to markdown doc for presentation page
  - ❏ Handle artifacts as members
- ❏ Content model
  - ❏ Multilingual support
  - ❏ Local overrides
  - ❏ Relatioships inference
  - ❏ Markdown support for individual fields
- ❏ Generator
  - ❏ htmlgen option for local file or webserver URL generation
  - ❏ Generate LL (multi)
  - ❏ Generate RDF (multi)
- ❏ Front end
  - ❏ Category browsing
  - ❏ Improve search indexing
  - ❏ Enhanced styling and access
- ❏ CLI
  - ❏ Dump & restore (whole archive & individual resources)
- ❏ Testing
    - ❏ Unit tests
    - ❏ >100 resource data set
- ❏ Documentation
  - ❏ Break main sections off README
  - ❏ Submission guide
  - ❏ Site generation guide
  - ❏ Content modeling guide (including proxy concepts)

## Post-basic

- Deposit via remote hot folder
  - FTP
  - S3
- Incremental build
- Rebuild only site assets
- Custom templating
- Deposit via S3 source pointer