Skip to content

docs(marketing): Pfad B discoverability, badges, sequence diagrams & PWA SEO metadata [G 2026-11-07] - #21

Open
lukisch wants to merge 1 commit into
masterfrom
docs/marketing-discoverability-seo-sequence-diagrams-20261107
Open

lukisch wants to merge 1 commit into
masterfrom
docs/marketing-discoverability-seo-sequence-diagrams-20261107

Conversation

@lukisch

@lukisch lukisch commented Nov 7, 2026

Copy link
Copy Markdown
Collaborator

Summary of Pfad B Marketing & Discoverability Enhancements

  1. International README Badge Parity (EN, DE, ES, JA, RU, ZH):

    • Added verified test badge (\ ests-204 passed) backed by real local test run measurement across all 6 language README editions.
    • Added core dependency badge (\core deps: zero (stdlib)) and local-first architecture badge (\storage: local-first) across all 6 editions.
  2. Sequence Diagram Architecture Parity (\README.md\ & \README_de.md):

    • Section 3 sequence diagrams enriched with the Local GUI Edit Server (\�dit_server.py) lifecycle on \127.0.0.1\ loopback.
    • Visualized Host header validation, PBKDF2 session verification, atomic CRUD write/rollback, soft-delete trash (\wikistub_seed_trash.json), and automatic PWA search index rebuild.
  3. PWA Landing Page & SEO Metadata (\web_publisher/index.html):

    • Implemented rich meta description, keywords, Open Graph (\og:title, \og:description, \og:type, \og:url, \og:image), and Twitter Card metadata (\ witter:card, \ witter:title, \ witter:description, \ witter:image) for discoverability and social previews.
  4. Community Health & Documentation Purity:

    • Corrected German umlauts in \CODE_OF_CONDUCT.md\ (\Geschlechtsidentität, \sexueller Identität).
  5. Quality Gates & Contract Tests:

    • Added \ est_readme_sequence_diagram_crud_edit_server_parity()\ and \ est_pwa_landing_page_seo_metadata()\ to \ ests/test_metadata.py.
    • Updated \ est_all_readme_international_badge_parity()\ with test count and architecture badge assertions.
    • Added SEO & Open Graph assertion to \web_publisher/tests/publisher.test.mjs\ (46/46 passed).
    • Local verification: 204/204 passed in pytest (100% green),
      uff check\ 0 errors, \lint_mermaid.py\ 0 syntax errors, \git diff --check\ clean.
    • Version 1.1.12 strictly frozen per T-20260920-167562623.

@github-actions

github-actions Bot commented Nov 7, 2026

Copy link
Copy Markdown

Welcome! Thanks for your first pull request in this repository.

A maintainer will review it soon. Please make sure:

  • Your changes are tested
  • Documentation is updated if needed
  • The PR description explains what and why

Thanks for contributing!

@lukisch lukisch left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zweitprüfung auf 5ff6c2b: keine Blocker, drei Ungenauigkeiten in den neuen Texten. (Als Kommentar, weil GitHub eine formale Freigabe des eigenen PRs nicht zulässt.)

Geprüft auf dem Head, zusätzlich probeweise mit aktuellem master (04de2de, #22) zusammengeführt: kein Konflikt.

  • pytest auf dem zusammengeführten Stand (Linux, Python 3.11): 203 bestanden, 1 fehlgeschlagen. Der Fehlschlag ist test_packaging.py::...test_wheel_sdist_and_installed_api_are_real_and_contained und liegt an meiner Umgebung (No module named build), nicht am PR. Mit dem Modul wären es die 204 aus dem Badge.
  • node --test web_publisher/tests/publisher.test.mjs: 46 von 46 bestanden.

Ungenauigkeiten

  1. Das Diagramm zeigt HTTP POST /api/entry. Die Route in edit_server.py heißt /api/entries (POST, PUT, DELETE). Betrifft README.md und README_de.md.
  2. „Verify Host header & PBKDF2 session cookie“: PBKDF2 sichert in wiki_auth.py das Passwort ab. Die Sitzung selbst ist ein Token im Cookie wiki_session, das der Session-Store prüft. Treffender wäre „Host-Header und Sitzungscookie prüfen“.
  3. og:image und twitter:image sind relative Pfade (./icons/Icon-512.png). Vorschau-Crawler brauchen dort absolute URLs, sonst erscheint kein Bild.

Hinweise, nicht blockierend

  • og:url verweist auf https://dev-bricks.github.io/WikiStub-Seed/. Die Adresse kommt sonst nirgends im Repo vor; ob dort eine Seite veröffentlicht ist, habe ich nicht geprüft.
  • Der PR-Text nennt das Badge einmal „storage: local-first“, im Diff heißt es „architecture: local-first“.
  • Die Einrückungskorrektur am Ende des deutschen Diagramms und die Umlautkorrektur in CODE_OF_CONDUCT.md sind richtig.

Generated by Claude Code

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