From 2a87fc95ba09d5501a7987377e2584f0743ebbb1 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Thu, 25 Jun 2026 20:33:15 +0100 Subject: [PATCH] docs(readme): convert README.adoc -> Markdown README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 --- README.adoc | 68 ---------------------------------------- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 89 insertions(+), 68 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 2e7a575..0000000 --- a/README.adoc +++ /dev/null @@ -1,68 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 -// Copyright (c) Jonathan D.A. Jewell -= InvestigativeJournalist.jl -:toc: macro -:toclevels: 2 -:icons: font - -image:https://img.shields.io/badge/Project-Topology-9558B2[Topology,link="TOPOLOGY.md"] -image:https://img.shields.io/badge/Completion-80%25-green[80%,link="TOPOLOGY.md"] -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/InvestigativeJournalist.jl"] -image:https://img.shields.io/badge/License-MPL--2.0-blue.svg[License: PMPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"] -image:https://api.thegreenwebfoundation.org/greencheckimage/github.com[Green Web,link="https://www.thegreenwebfoundation.org/green-web-check/?url=github.com"] -image:https://img.shields.io/badge/Julia-1.10+-9558B2?logo=julia[Julia,link="https://julialang.org/"] - -*Structured Evidence for High-Stakes Reporting* - -_Turn messy source material into audit-ready investigative artifacts._ - -toc::[] - -== Overview - -InvestigativeJournalist.jl is a Julia toolkit for managing the end-to-end investigative reporting workflow. It provides high-integrity structures for ingesting diverse sources, extracting verifiable claims, and building a corroboration matrix that minimizes editorial and legal risk. - -== Core Capabilities - -* **Multi-Source Ingestion**: Ingest documents, web snapshots, and interview notes with automatic hashing and deduplication. -* **Claim Extraction**: Extract discrete claims and link them to entities (people, orgs, places). -* **Corroboration Matrix**: Quantify confidence levels across claims and multiple supporting sources. -* **Auditable Provenance**: Every claim in your final draft traces back to a cryptographically hashed source document. -* **Timeline & Network Analysis**: Visualize actors and events to detect gaps or contradictions in narratives. - -== Quick Start - -[source,julia] ----- -using InvestigativeJournalist - -# Ingest a source document -doc = ingest_source("docs/leaked_contract.pdf") - -# Extract claims and link to entities -claims = extract_claims(doc) -link_entities!(claims) - -# Build a corroboration matrix -matrix = corroborate(claims, all_docs()) - -# Generate a publication-ready evidence pack -pack = generate_publication_pack(story_draft) ----- - -== Suggested Tech Stack - -* **Data**: `DataFrames.jl`, `Arrow.jl`, `JSON3.jl` -* **Persistence**: `SQLite.jl` or `DuckDB.jl` -* **Text Analysis**: `TextAnalysis.jl` -* **Visualization**: `Makie.jl` - -== Safety & Governance - -* **Source Protection**: Support for encrypted fields and redacted exports for sensitive whistleblowers. -* **Audit Trail**: Immutable logs for every change in confidence scores or claim text. -* **Zero-Unreferenced Policy**: Final publication packages prevent inclusion of any claim without a verified evidence link. - -== License - -Palimpsest-MPL-1.0 License - see link:LICENSE[LICENSE] for details. diff --git a/README.md b/README.md new file mode 100644 index 0000000..3c1ed6e --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ + + +[![Topology](https://img.shields.io/badge/Project-Topology-9558B2)](TOPOLOGY.md) +[![80](https://img.shields.io/badge/Completion-80%25-green)](TOPOLOGY.md) [![OpenSSF Best Practices](https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity)](https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/InvestigativeJournalist.jl) +[![License: PMPL-1.0](https://img.shields.io/badge/License-MPL--2.0-blue.svg)](https://github.com/hyperpolymath/palimpsest-license) +image:Julia + +**Structured Evidence for High-Stakes Reporting** + +*Turn messy source material into audit-ready investigative artifacts.* + +
+ +
+ +# Overview + +InvestigativeJournalist.jl is a Julia toolkit for managing the +end-to-end investigative reporting workflow. It provides high-integrity +structures for ingesting diverse sources, extracting verifiable claims, +and building a corroboration matrix that minimizes editorial and legal +risk. + +# Core Capabilities + +- **Multi-Source Ingestion**: Ingest documents, web snapshots, and + interview notes with automatic hashing and deduplication. + +- **Claim Extraction**: Extract discrete claims and link them to + entities (people, orgs, places). + +- **Corroboration Matrix**: Quantify confidence levels across claims and + multiple supporting sources. + +- **Auditable Provenance**: Every claim in your final draft traces back + to a cryptographically hashed source document. + +- **Timeline & Network Analysis**: Visualize actors and events to detect + gaps or contradictions in narratives. + +# Quick Start + +```julia +using InvestigativeJournalist + +# Ingest a source document +doc = ingest_source("docs/leaked_contract.pdf") + +# Extract claims and link to entities +claims = extract_claims(doc) +link_entities!(claims) + +# Build a corroboration matrix +matrix = corroborate(claims, all_docs()) + +# Generate a publication-ready evidence pack +pack = generate_publication_pack(story_draft) +``` + +# Suggested Tech Stack + +- **Data**: `DataFrames.jl`, `Arrow.jl`, `JSON3.jl` + +- **Persistence**: `SQLite.jl` or `DuckDB.jl` + +- **Text Analysis**: `TextAnalysis.jl` + +- **Visualization**: `Makie.jl` + +# Safety & Governance + +- **Source Protection**: Support for encrypted fields and redacted + exports for sensitive whistleblowers. + +- **Audit Trail**: Immutable logs for every change in confidence scores + or claim text. + +- **Zero-Unreferenced Policy**: Final publication packages prevent + inclusion of any claim without a verified evidence link. + +# License + +Palimpsest-MPL-1.0 License - see [LICENSE](LICENSE) for details.