Skip to content

docs(marketing): Path B discoverability, P-022 SKILL.md, llm.txt/llms.txt & README parity (v1.0.5 frozen) - #14

Open
lukisch wants to merge 1 commit into
mainfrom
docs/marketing-p022-discoverability-20261114
Open

lukisch wants to merge 1 commit into
mainfrom
docs/marketing-p022-discoverability-20261114

Conversation

@lukisch

@lukisch lukisch commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Summary / Zusammenfassung

  • Product Skill & LLM Entry Point (Policy P-022):
    • Added standalone root product skill SKILL.md documenting supported scope, zero-egress/UTF-8/PDF-overwrite boundaries, isolated .venv setup, verified commands (--smoke-test, --self-test, manage_translations.py --check,
      ode --test tests/test_web_renderer.cjs, pytest), exit codes, and the cleanmarkdown-session-v1.json schema.
    • Added compatibility pointer llm.txt referencing llms.txt and SKILL.md without duplicating canonical state.
    • Updated .gitignore so the public product SKILL.md is intentionally tracked per P-022.
    • Updated llms.txt to 2026-11-14 with the four machine-readable install/verification blocks, 6-language UI (de, �n, �s, zh, ja,
      u), Web Companion (web_companion/), and Flutter port ( lutter_port/).
  • Multilingual README Parity (README.md, README_DE.md, README_es.md, README.es.md):
    • Added the safe 1-click copyable Mit deinem LLM installieren / Install with your LLM / Instalar con tu LLM / Install with your LLM code block referencing llms.txt and SKILL.md.
    • Linked SKILL.md and llm.txt in badges and top notes while preserving existing banners (�ssets/banner.png).
    • Added missing CI-Vertrag link in README_DE.md and synchronized verified dates (2026-11-14) and real measured test counts (291 passed, 1 skipped on Windows without symlink privilege; 292 collected + 6 Node web renderer tests).
    • Updated CHANGELOG.md under ## [Unreleased] with version 1.0.5 strictly frozen per T-20260920-167562623.
  • Contract Tests ( ests/test_metadata.py):
    • Updated est_llms_txt_integrity and added est_product_skill_and_llm_pointer_exist_and_not_ignored and est_readme_install_with_llm_section_parity.

Verification / Verifikation


  • uff check .: 0 errors
  • \python -m py_compile main.py translator.py manage_translations.py generate_store_screenshots.py launcher.py: 0 errors

  • ode --test tests/test_web_renderer.cjs: 6/6 passed
  • \python manage_translations.py --check: 143/143 keys OK across 6 languages
  • \python main.py --self-test: all checks \ok, exit 0
  • \lint_mermaid.py: 31 Markdown files, 4 Mermaid diagrams, 0 syntax errors
  • \pytest -ra -v: 291 passed, 1 skipped (292 collected; Windows symlink skip in \ est_pdf_original_protection.py)
  • Version \1.0.5\ (\store_package.json\ \1.0.5.0) unchanged; \MARKETING-LOG.txt\ untouched.

@lukisch lukisch left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Zweitmodell-Abnahme: inhaltlich freigabefähig, ein Doku-Befund (niedrig).

Gegen den Code geprüft und bestätigt:

  • --smoke-test und --self-test gibt es in main.py (Z. 2564/2566). manage_translations.py --check existiert ebenfalls.
  • Das Session-Schema in SKILL.md (version, fileName, markdown, theme paper/night, workspace read/write/split, updatedAt) stimmt mit EXPORTFORMAT.md und main.py überein.
  • SKILL.md und llm.txt sind nicht mehr ignoriert (git check-ignore ohne Treffer). Der neue Vertragstest prüft das ebenfalls.
  • generate_store_screenshots.py, launcher.py und start.bat liegen im Root. Die erweiterte py_compile-Zeile im README ist damit gültig.
  • CI: alle 8 Desktop-Jobs (ubuntu/windows × 3.10–3.13), Flutter und CodeQL sind grün. Mergeable: clean.

Befund (Doku-Abweichung, niedrig): SKILL.md Z. 32 und llms.txt Z. 34 nennen als Laufzeit-Pins PySide6>=6.5.0,!=6.12.0 und markdown>=3.4.0. llms.txt schreibt dazu „in requirements.txt“. Dort steht aber:

PySide6>=6.10,<7,!=6.12.0
Markdown>=3.10,<4

Die Werte im PR stammen aus pyproject.toml (dependencies). SKILL.md lässt über requirements.txt installieren. Ein Agent, der nach den Pins im Skill prüft, akzeptiert damit Versionen, die die tatsächliche Installation ausschließt.
Vorschlag: In SKILL.md und llms.txt die Pins aus requirements.txt übernehmen. Alternativ die Abweichung zwischen pyproject.toml und requirements.txt in einem eigenen PR auflösen. Das blockiert den Merge nicht.

Kosmetik: Im PR-Body sind mehrere Backticks/Escapes kaputt (\uff check, ^[n, ests/…). Die Dateien selbst sind sauber.


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