difficult-dialogs 0.3__tar.gz → 0.6.0a1__tar.gz

difficult_dialogs-0.6.0a1/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 TigreGotico
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

difficult_dialogs-0.6.0a1/PKG-INFO

@@ -0,0 +1,479 @@
+Metadata-Version: 2.4
+Name: difficult_dialogs
+Version: 0.6.0a1
+Summary: Structured argument framework for meaningful debates
+Author-email: JarbasAl <jarbasai@protonmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/difficult_dialogs
+Project-URL: Documentation, https://github.com/TigreGotico/difficult_dialogs#readme
+Project-URL: Repository, https://github.com/TigreGotico/difficult_dialogs
+Project-URL: Issues, https://github.com/TigreGotico/difficult_dialogs/issues
+Keywords: argument,debate,dialog,llm,reasoning,logic
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-plugin-manager>=0.0.1
+Requires-Dist: ovos-solver-yes-no-plugin
+Requires-Dist: ovos-solver-bm25-plugin
+Requires-Dist: rank-bm25>=0.2.2
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Provides-Extra: cli
+Requires-Dist: tqdm>=4.65.0; extra == "cli"
+Provides-Extra: watch
+Requires-Dist: watchdog>=3.0.0; extra == "watch"
+Provides-Extra: export
+Provides-Extra: web
+Requires-Dist: streamlit>=1.28.0; extra == "web"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.100.0; extra == "server"
+Requires-Dist: uvicorn[standard]>=0.23.0; extra == "server"
+Provides-Extra: all
+Requires-Dist: tqdm>=4.65.0; extra == "all"
+Requires-Dist: streamlit>=1.28.0; extra == "all"
+Requires-Dist: fastapi>=0.100.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.23.0; extra == "all"
+Requires-Dist: watchdog>=3.0.0; extra == "all"
+Dynamic: license-file
+
+# difficult_dialogs
+
+**Structured argumentation framework — compile knowledge once, run debates forever.**
+
+[![Tests](https://img.shields.io/badge/tests-794%20passed-brightgreen)]()
+[![Coverage](https://img.shields.io/badge/coverage-97%25-green)]()
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)]()
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue)]()
+
+---
+
+## The Problem
+
+LLMs are great for debates, but they:
+- ❌ Hallucinate facts mid-conversation
+- ❌ Cost money per call at scale
+- ❌ Add 2–5 s latency per turn
+- ❌ Require network access
+
+## The Solution
+
+**Generate arguments once with an LLM. Run them forever without one.**
+
+```
+┌──────────────────┐     ┌──────────────────────┐     ┌───────────────────┐
+│  LLM (one-time)  │     │  Plain-text files     │     │  Policy engine    │
+│  generate once   │────▶│  .premise  .support   │────▶│  deterministic    │
+│  ~60 s / topic   │     │  .source   .why  .who │     │  <1 ms / turn     │
+└──────────────────┘     └──────────────────────┘     └───────────────────┘
+      Smart                  Auditable, git-friendly       Offline, free
+```
+
+Optionally layer an `LLMEnhancedPolicy` on top to rephrase responses at runtime — without changing the locked argument structure.
+
+---
+
+## Install
+
+```bash
+uv pip install difficult-dialogs                  # core + OVOS yes/no solver
+uv pip install "difficult-dialogs[server]"        # + FastAPI REST server
+uv pip install "difficult-dialogs[dev]"           # + pytest, ruff, mypy
+```
+
+Python 3.10+. Requires `ovos-plugin-manager`, `ovos-solver-yes-no-plugin`, `ovos-solver-bm25-plugin`, and `rank-bm25` (all installed automatically).
+
+---
+
+## Quick start
+
+### CLI
+
+```bash
+dd debate    examples/i_think_therefore_i_am        # interactive debate
+dd list      examples/sample_arguments              # browse library
+dd validate  examples/sample_arguments              # quality report
+dd serve     --port 8080                            # REST API server
+dd generate  "Solar energy is cost-effective" \
+             --server http://localhost:8000          # LLM-generate an argument
+```
+
+### Python
+
+```python
+from difficult_dialogs import Argument, KnowItAllPolicy
+
+arg = Argument.from_directory("examples/i_think_therefore_i_am")
+policy = KnowItAllPolicy(arg)
+
+print(policy.start())
+
+gen = policy.run_sync()
+response = next(gen)
+while response:
+    print("BOT:", response)
+    try:
+        response = gen.send(input("USER: "))
+    except StopIteration:
+        break
+```
+
+### Fluent builder
+
+```python
+from difficult_dialogs.builder import ArgumentBuilder
+
+arg = (
+    ArgumentBuilder("climate_change")
+    .intro("Let's discuss climate change.")
+    .conclusion("The evidence is clear.")
+    .premise("human_causation")
+        .statement("97% of climate scientists agree.")
+        .support("See IPCC AR6.")
+        .source("https://www.ipcc.ch/")
+        .why("CO₂ traps heat in the atmosphere.")
+        .who("Climate scientists and IPCC working groups.")
+        .done()
+    .build()
+)
+```
+
+---
+
+## File format
+
+Arguments are plain-text directories — one subdirectory per premise:
+
+```
+argument_name/
+├── intro.dialog              # Opening statement
+├── conclusion.conclusion     # Closing statement
+└── premise_name/
+    ├── premise_name.premise  # Core claims (one per line)
+    ├── premise_name.support  # Comeback arguments (optional)
+    ├── premise_name.source   # Citation URLs (optional)
+    ├── premise_name.what     # Six-Ws contextual fields (optional)
+    ├── premise_name.why
+    ├── premise_name.how
+    ├── premise_name.when
+    ├── premise_name.where
+    └── premise_name.who
+```
+
+UTF-8, one entry per line. Works with `git diff`, `grep`, any text editor.
+Full reference: [docs/argument-format.md](docs/argument-format.md)
+
+---
+
+## Graph visualization
+
+Arguments with branching (`.on_agree`/`.on_disagree`/`.choices`) form directed
+graphs. Visualize with `did graph`:
+
+```bash
+did graph examples/sample_arguments/technology/should_ai_be_regulated
+```
+
+```mermaid
+graph TD
+    ai_risk(["ai_risk\n(2 stmts)"])
+    oversight{"oversight\n(2 stmts)"}
+    innovation["innovation\n(2 stmts)"]
+    balance["balance\n(2 stmts)"]
+    implementation["implementation\n(2 stmts)"]
+    ai_risk -->|"agree"| oversight
+    ai_risk -->|"disagree"| innovation
+    oversight -->|"choice:A"| implementation
+    oversight -->|"choice:B"| balance
+    innovation -->|"agree"| balance
+    innovation -->|"disagree"| oversight
+    style ai_risk stroke-width:3px
+```
+
+Also available as DOT (`--format dot`) and JSON (`--format json`).
+Browse all sample graphs: [docs/GRAPHS.md](docs/GRAPHS.md)
+
+---
+
+## Policies
+
+Policies are the "personality" of the dialog. The argument content never changes.
+
+| Policy | Style | Uses support | Asks questions |
+|---|---|---|---|
+| `KnowItAllPolicy` | Persuasive — corrects with evidence | ✅ | ❌ |
+| `SilentPolicy` | Lecture — no interaction | ❌ | ❌ |
+| `SocraticPolicy` | Questioning — Socratic method | ✅ | ✅ |
+| `DebatePolicy` | Adversarial — challenges user | ✅ | ✅ |
+| `ExploratoryPolicy` | Neutral — presents multiple sides | ✅ | ✅ |
+| `MaieuticPolicy` | Guided discovery | ✅ | ✅ |
+| `SkepticPolicy` | Doubting — user must prove it | ✅ | ✅ |
+| `TeacherPolicy` | Educational — lesson structure | ✅ | ✅ |
+| `DebaterPolicy` | Formal debate rules | ✅ | ✅ |
+| `MinimalistPolicy` | Terse confirmations only | ❌ | ❌ |
+| `AdaptivePolicy` | Switches policy after N disagreements | via inner | via inner |
+| `WebhookPolicy` | Forwards to HTTP endpoint, local fallback | ✅ | ❌ |
+| `LLMEnhancedPolicy` | Rephrases responses via LLM at runtime | via inner | via inner |
+| `MultiArgumentPolicy` | Chains multiple arguments sequentially | via inner | via inner |
+
+```python
+from difficult_dialogs import get_policy, Argument
+
+arg = Argument.from_directory("my_argument")
+policy = get_policy("socratic", arg)   # by name via POLICY_REGISTRY
+```
+
+Full reference: [docs/POLICIES.md](docs/POLICIES.md)
+
+### LLMEnhancedPolicy
+
+Add natural language variety to any policy without changing its argument logic:
+
+```python
+from difficult_dialogs.policy import LLMEnhancedPolicy, KnowItAllPolicy
+from difficult_dialogs.llm import LLMEnhancer
+
+enhancer = LLMEnhancer("http://localhost:8000", model="qwen-7b")
+policy = LLMEnhancedPolicy(
+    arg,
+    inner_policy=KnowItAllPolicy(arg),
+    enhancer=enhancer,
+    style="friendly",   # "conversational" | "formal" | "friendly" | "academic"
+)
+```
+
+Falls back silently to original text if the LLM server is unreachable.
+
+### AdaptivePolicy
+
+Automatically softens approach when the user keeps disagreeing:
+
+```python
+from difficult_dialogs import AdaptivePolicy, KnowItAllPolicy, ExploratoryPolicy
+
+policy = AdaptivePolicy(
+    arg,
+    initial_policy=KnowItAllPolicy(arg),
+    fallback_policy=ExploratoryPolicy(arg),
+    switch_threshold=3,
+)
+```
+
+### MultiArgumentPolicy
+
+Chain multiple arguments into one session:
+
+```python
+from difficult_dialogs import MultiArgumentPolicy
+
+policy = MultiArgumentPolicy(
+    [(intro_arg, "silent"), (main_arg, "knowitall"), (close_arg, "minimalist")]
+)
+```
+
+---
+
+## Session state & transcripts
+
+```python
+# Save
+state_dict = policy.state.to_dict()   # JSON-safe dict
+
+# Restore
+policy.restore_state(state_dict)
+
+# Export transcript
+from difficult_dialogs.export.transcript import export_transcript_to_markdown
+md = export_transcript_to_markdown(policy, title="Session 1")
+```
+
+---
+
+## Argument library search
+
+```python
+from difficult_dialogs.library import ArgumentLibrary
+
+lib = ArgumentLibrary("arguments/").scan()
+results = lib.search("climate change", limit=5)
+for r in results:
+    print(r.argument.name, r.score)
+
+lib.by_category("health")    # all arguments in a top-level subdirectory
+lib.get("free_will_exists")  # direct lookup by name
+```
+
+---
+
+## Export
+
+```python
+from difficult_dialogs.export import export_to_json, export_to_markdown
+from difficult_dialogs.export.sqlite import LibraryDatabase
+
+export_to_json(arg, "argument.json")
+export_to_markdown(arg, "argument.md")
+
+db = LibraryDatabase("library.db")
+db.add_argument(arg, category="philosophy")
+db.close()
+
+# Argument diff — review LLM-generated changes before committing
+diff = original.diff(updated)
+# {"meta": ..., "added_premises": [...], "removed_premises": [...], "modified_premises": {...}}
+```
+
+---
+
+## LLM generation
+
+Requires an OpenAI-compatible server (Ollama, llama.cpp, OpenAI API, etc.):
+
+```python
+from difficult_dialogs.llm import ArgumentGenerator
+
+gen = ArgumentGenerator("http://localhost:8000", model="qwen-72b")
+arg = gen.generate("Solar energy is cost-effective", stance="pro", depth=2)
+arg.save("arguments/solar_energy")
+```
+
+Or from the CLI:
+
+```bash
+dd generate "Solar energy is cost-effective" \
+  --server http://localhost:11434 \
+  --model qwen-72b \
+  --output arguments/
+```
+
+**Supported servers:**
+```bash
+ollama serve                                               # http://localhost:11434
+./llama-server -m model.gguf --host 0.0.0.0 --port 8000   # http://localhost:8000
+# OpenAI: --server https://api.openai.com/v1 --model gpt-4o
+```
+
+---
+
+## REST server
+
+```bash
+dd serve --host 0.0.0.0 --port 8080
+```
+
+| Endpoint | Description |
+|---|---|
+| `POST /sessions` | Create session (`argument_path`, `policy`) |
+| `POST /sessions/{id}/chat` | Send turn (`user_input`) |
+| `GET  /sessions/{id}` | Full session info |
+| `GET  /sessions/{id}/state` | Serialized `PolicyState` |
+| `PUT  /sessions/{id}/state` | Restore saved state |
+| `DELETE /sessions/{id}` | End session |
+| `GET  /arguments` | List available argument directories |
+
+---
+
+## Validation
+
+```python
+from difficult_dialogs.validators import validate_argument, get_quality_label
+
+result = validate_argument(arg)
+print(result.score)                     # 0.0–1.0
+print(get_quality_label(result.score))  # "Excellent ⭐" | "Good 👍" | "Fair 😐" | "Poor ❌"
+for issue in result.issues:
+    print(issue)
+```
+
+---
+
+## Testing
+
+```bash
+uv run pytest test/ -v
+uv run pytest test/ --cov=difficult_dialogs --cov-report=term-missing
+```
+
+**794 tests, 97% average coverage.**
+
+---
+
+## Project layout
+
+```
+difficult_dialogs/
+├── statements.py        # Statement dataclass
+├── premises.py          # Premise — Six Ws: what/why/how/when/where/who
+├── arguments.py         # Argument — load/save/diff/merge
+├── builder.py           # ArgumentBuilder / PremiseBuilder fluent API
+├── policy.py            # BasePolicy + 14 concrete policies + registry
+├── library.py           # ArgumentLibrary — keyword search
+├── validators.py        # Quality scoring
+├── server.py            # FastAPI REST server
+├── cli.py               # dd / difficult-dialogs CLI
+├── export/
+│   ├── json.py          # JSON export
+│   ├── sqlite.py        # SQLite export
+│   ├── markdown.py      # Markdown export
+│   └── transcript.py    # Session transcript export
+└── llm/
+    ├── client.py        # OpenAI-compatible HTTP client
+    ├── generator.py     # Argument generation from topic string
+    └── enhancer.py      # Runtime statement rephrasing
+```
+
+---
+
+## Comparison
+
+| | difficult_dialogs | Raw LLM | Other debate tools |
+|---|---|---|---|
+| Cost per debate | $0 (after generation) | $0.10–0.50 | Varies |
+| Latency | <1 ms | 2–5 s | 1–3 s |
+| Offline | ✅ | ❌ | ❌ |
+| Hallucinations | ❌ none | ✅ possible | ⚠️ sometimes |
+| Auditable content | ✅ plain text | ❌ black box | ⚠️ limited |
+| Git-versionable | ✅ | ❌ | ⚠️ |
+| LLM enhancement | optional | required | n/a |
+
+---
+
+## Documentation
+
+- [docs/index.md](docs/index.md) — Overview and navigation
+- [docs/argument-format.md](docs/argument-format.md) — File format reference
+- [docs/USER_GUIDE.md](docs/USER_GUIDE.md) — End-user manual
+- [docs/DEVELOPER_GUIDE.md](docs/DEVELOPER_GUIDE.md) — API reference
+- [docs/POLICIES.md](docs/POLICIES.md) — All 15 policies documented
+- [docs/GRAPHS.md](docs/GRAPHS.md) — Premise graphs for all sample arguments
+- [docs/cli.md](docs/cli.md) — CLI reference (`did graph`, `did stats`, `did debate`, …)
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/TigreGotico/difficult_dialogs
+cd difficult_dialogs
+uv pip install -e ".[dev]"
+uv run pytest test/ -v
+```
+
+PRs target the `dev` branch.
+Issues: https://github.com/TigreGotico/difficult_dialogs/issues
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).