<commit_before>= Documentation of this Webapp
:swsample: https://googlechrome.github.io/samples/service-worker/custom-offline-page/

Technical documentation of the contents of this directory.

== Status
This document is being written *as* I'm writing the webapp, so things here will
likely be incorrect. As of this writing, this is more documentation on
design/intention.

== Overview
The files in this directory represent the root of this web application. The
landing page is index.html. The page is a static web application with only
JavaScript at play and pre-generated content _(via some shell scripts in
`../../`)_.

=== Purpose
The end-goal of this webapp is to facilitate offline display of front, then back
of <<flashcards>> (webp images) on a phone, without an internet connection.

== Architecture
Currently planning to use latest service worker APIs to serve the app out of
plain static file servers (in my case, my personal CDN), and achieve offline
caching on my phone. To do this I've read some of the tutorials released by
Google developer advocates and am roughly modeling HTML and JavaScript files-
directly under `./` - after "[Service Worker Sample: Custom Offline Page
Sample]{swsample}".

[cols="2", options="header"]
|===
| description                     | file

| root of web app                 | `./`
| this file                       | `./README.adoc`
| main HTTP requests              | `./index.html`
| main bootstrap/gluecode logic   | `./index.js`
| service worker (network) logic  | `./worker.js`

| main studying UI & offline default landing page
| `./study.html` _(`offline.html` in tutorials)_

| Flashcard studying UI logic     | `./study.js`
| UTF-8 encoded metadata file     | `./cards.index`
| root of all flashcards sets     | `./cards/`
| example flashcard set           | `./cards/sampleset_calc/`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/index`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/title`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/description`<commit_msg>nit(doc) fix broken asciidoc link<commit_after>= Documentation of this Webapp
:swsample: https://googlechrome.github.io/samples/service-worker/custom-offline-page/

Technical documentation of the contents of this directory.

== Status
This document is being written *as* I'm writing the webapp, so things here will
likely be incorrect. As of this writing, this is more documentation on
design/intention.

== Overview
The files in this directory represent the root of this web application. The
landing page is index.html. The page is a static web application with only
JavaScript at play and pre-generated content _(via some shell scripts in
`../../`)_.

=== Purpose
The end-goal of this webapp is to facilitate offline display of front, then back
of <<flashcards>> (webp images) on a phone, without an internet connection.

== Architecture
Currently planning to use latest service worker APIs to serve the app out of
plain static file servers (in my case, my personal CDN), and achieve offline
caching on my phone. To do this I've read some of the tutorials released by
Google developer advocates and am roughly modeling HTML and JavaScript files-
directly under `./` - after {swsample}["Service Worker Sample: Custom Offline
Page Sample"].

[cols="2", options="header"]
|===
| description                     | file

| root of web app                 | `./`
| this file                       | `./README.adoc`
| main HTTP requests              | `./index.html`
| main bootstrap/gluecode logic   | `./index.js`
| service worker (network) logic  | `./worker.js`

| main studying UI & offline default landing page
| `./study.html` _(`offline.html` in tutorials)_

| Flashcard studying UI logic     | `./study.js`
| UTF-8 encoded metadata file     | `./cards.index`
| root of all flashcards sets     | `./cards/`
| example flashcard set           | `./cards/sampleset_calc/`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/index`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/title`
| UTF-8 encoded metadata file     | `./cards/sampleset_calc/description`
{'fraction_non_alphanumeric': 0.09864603481624758, 'fraction_numerical': 0.0024177949709864605, 'mean_word_length': 3.3138686131386863, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1412911', 'n_tokens_mistral': 1145, 'n_tokens_neox': 1092, 'n_words': 485}