Skip to content

docs: everything the mapping file may hold - #46

Merged
gustavommcv merged 1 commit into
mainfrom
docs/mapping-file-keys
Oct 25, 2026
Merged

gustavommcv merged 1 commit into
mainfrom
docs/mapping-file-keys

Conversation

@gustavommcv

Copy link
Copy Markdown
Owner

What and why

The README showed the mapping file by its volumes and its chapter_versions alone. A test (TestLoadIgnoresKeysItDoesNotKnow) says that Manga2Ink keeps manga.author and manga.language in the file, "see the README", and the README said nothing of them, nor of manga, source or the keys another program may keep.

A table under "When chapter names don't carry a volume number" now lists every key: schema_version (required, 1), volumes (may be empty or left out, and is not used with --no-volumes), chapter_versions (used with or without volumes), manga (title, and the author and language a program keeps; not read), source (not read), and that any other key is ignored. It also says that a series with no volumes needs no file at all: --no-volumes (ADR 0030).

Verification

Documentation only; go test ./... passes, including the test that checks the protocol document against the issue codes.

@gustavommcv
gustavommcv merged commit 00ee2b5 into main Oct 25, 2026
6 checks passed
@gustavommcv
gustavommcv deleted the docs/mapping-file-keys branch October 25, 2026 21:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant