diff options
| author | Paul Buetow <paul@buetow.org> | 2026-06-19 21:28:29 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-06-19 21:28:29 +0300 |
| commit | 7fed72298b36c9aecae849a57a615b85f15552d4 (patch) | |
| tree | 660d66fa7b7a5b14c0ed5261cba8a698a475fa77 /docs | |
| parent | 2cdec0ccd3ec1fdcafdc4f12fb30c7d58c7632b8 (diff) | |
docs: polish readability of quick-start and reference pages
- Friendlier, less jargon-heavy quick-start comments in README.
- Simplify the --config row in the README main-flags table.
- Replace <...> HTML entities with backtick code spans in
generation.md and templates.md.
- Rephrase the supported-images note in configuration.md to drop the
find-specific 'maxdepth 1' phrasing in favour of plain English.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.md | 9 | ||||
| -rw-r--r-- | docs/generation.md | 2 | ||||
| -rw-r--r-- | docs/templates.md | 2 |
3 files changed, 7 insertions, 6 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 07bc1e0..d6471b4 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -38,10 +38,11 @@ values for the current run. ## Supported source images -Only regular files in `INCOMING_DIR` (top level, `maxdepth 1`) with supported -image extensions are processed as album images. Supported extensions are `jpg`, -`jpeg`, `png`, `webp`, and `gif`, matched case-insensitively. Other files, such -as `.txt` or `.md` notes, are ignored with a warning so generation can continue. +Only regular files found directly in `INCOMING_DIR` (not in subdirectories) with +supported image extensions are processed as album images. Supported extensions +are `jpg`, `jpeg`, `png`, `webp`, and `gif`, matched case-insensitively. Other +files, such as `.txt` or `.md` notes, are ignored with a warning so generation +can continue. ## Validation diff --git a/docs/generation.md b/docs/generation.md index b477b30..c377adf 100644 --- a/docs/generation.md +++ b/docs/generation.md @@ -110,6 +110,6 @@ file instead (it is copied in as `favicon.ico`). ## Source URL The page header bar links to the project source ("Site generated … with -<URL>"). This defaults to the shuriken.sh repository; set `SOURCE_URL` in +`<URL>`"). This defaults to the shuriken.sh repository; set `SOURCE_URL` in the config or pass `--source-url URL` to point it at your own album's repository instead. The displayed link text is the URL with its scheme removed.
\ No newline at end of file diff --git a/docs/templates.md b/docs/templates.md index f34be9d..8d26f61 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -28,7 +28,7 @@ used when `STATS_PAGE=yes`. ## Header bar and footer * The page **header bar** (`header.tmpl`) renders the "Site generated … with - <SOURCE_URL>" link and, when `STATS_PAGE=yes`, the `Stats` navigation + `<SOURCE_URL>`" link and, when `STATS_PAGE=yes`, the `Stats` navigation link. * The page **footer** (`footer.tmpl`) renders the "Download all photos in original size" tarball link, shown only when `TARBALL_INCLUDE=yes`.
\ No newline at end of file |