Files
pages/docs/design/README.md
T
Anya Tokugawa c1175d389f Implement Knowledge City platform, organizer and DAV integration
Capture accumulated application, UI, CLI, regression tests and design documentation changes, including task project mapping and default CalDAV list naming.

Keep deployment data, backups, local credentials and build artifacts out of Git. Move the Compose enrollment token to an ignored local environment file.
2026-09-27 14:44:43 +09:00

3.0 KiB
Raw Permalink Blame History

PagesWiki design documentation

Current reading order

The reorganized Japanese handbook is ja/index.md, published under https://pages.anya.jp/lab/pageswiki-dev/. It separates implemented slices, proposals, unresolved decisions and delivery gates. Its chapter identifiers are language-neutral; existing English source documents remain here for traceability and future aligned translations, not as automatically current English editions.

  • Concepts and boundaries: chapters 1–6.
  • Existing product and runtime: chapters 7–11.
  • Organizer / task / calendar / RSS / mail / HTML editing proposals: chapters 12–17.
  • Operations, i18n, ordered work, decisions and sources: chapters 18–22.
  • Source-to-chapter inventory.
  • Decision and inconsistency register.

Document roles

arch.md, address-model.md, access-model.md, auth.md and i18n-delivery.md include original conceptual drafts. Detailed topic documents describe contracts and implementation slices. implementation-status.md contains dated progress; older paragraphs are historical and may be superseded. The roadmap is a task inventory; the execution ledger is verification/deployment history, not a blanket feature-completeness claim.

For new work, update the relevant chapter and detailed contract together. Keep stable identity, authorization and bounded processing constraints. Do not convert design proposals into active features or public grants merely by documenting them.

Publication

Japanese Markdown under ja/ is the editing source. The documentation export tool renders canonical HTML with the application's Markdown renderer, validates chapter links, and emits a manifest. Upload through the trusted data CLI with an explicit Domain and PAGESWIKI_LANG=ja; no authentication/publication policy is changed. Record resulting Page/Revision identities separately from source text. English publication is deferred until an aligned translation and language UI are ready. Never overwrite Japanese with English at language und.

Generate a fresh, empty staging directory, then run:

go run ./tools/design-export -out /tmp/pageswiki-design-staging
go test ./tools/design-export

The tool does not access the database or network. Review manifest.json, check destination collisions, and select the correct database/Domain explicitly before using data/pageswiki-cli put for each rendered HTML file and manifest Path. The index maps to /lab/pageswiki-dev, not /lab/pageswiki-dev/index. Do not blindly replace existing Wiki edits on a later publication: compare the recorded Revision UUID/hash with the current head and resolve divergence first.

The initial upload receipt is publication-ja-2026-09-19.json. All 23 canonical payloads were read back and compared. Source hashes and stored Page/Revision identities support later language alignment. Anonymous HTTPS access still redirects to login; this upload did not change public access settings.