Skip to content

Commit 48b8c39

Browse files
author
KoyoAli
committed
Tidy documentation and validation scripts
1 parent b13d41a commit 48b8c39

22 files changed

Lines changed: 103 additions & 224 deletions

.github/workflows/checks.yml

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,3 @@ jobs:
3434
steps:
3535
- uses: actions/checkout@v4
3636
- run: python validation/check_duplicates.py
37-
38-
# ---- Planned checks, visible on purpose (honest roadmap). Disabled until built. ----
39-
language-identity:
40-
name: language identity (planned — year 1)
41-
if: false
42-
runs-on: ubuntu-latest
43-
steps: [{ run: "echo planned" }]
44-
benchmark-leakage:
45-
name: benchmark leakage (planned — needs holdout list)
46-
if: false
47-
runs-on: ubuntu-latest
48-
steps: [{ run: "echo planned" }]
49-
provenance-gate:
50-
name: provenance & rights gate (planned — vocabulary TBD)
51-
if: false
52-
runs-on: ubuntu-latest
53-
steps: [{ run: "echo planned" }]

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ Every released version: what changed, what was corrected, what was withdrawn.
44

55
## [Unreleased]
66

7-
## [1.0.0] - TODO
7+
## [1.0.0] - 2026-08-31
88
- Initial public release.

CITATION.cff

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,3 @@ date-released: "2026-08-31"
1010
license: CDLA-Permissive-2.0
1111
repository-code: "https://github.com/Okwu-AI/corpus"
1212
url: "https://huggingface.co/datasets/Okwu/african-language-parallel-corpus"
13-
# doi: added when the Zenodo record is reserved

CODEOWNERS

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
# Every change needs an owner review. Update as maintainers are added.
21
* @Okwu-AI/maintainers
32
/schema/ @Okwu-AI/maintainers
43
/release/ @Okwu-AI/maintainers

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
version = "2.1"
33
aliases = ["/version/2/1"]
4-
reportingPlaceholder = "[INSERT CONTACT METHOD]"
4+
reportingPlaceholder = "conduct@okwu.ai"
55
+++
66

77
# Contributor Covenant Code of Conduct
@@ -42,7 +42,7 @@ This Code of Conduct applies within all community spaces, and also applies when
4242

4343
## Enforcement
4444

45-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
45+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at conduct@okwu.ai. All complaints will be reviewed and investigated promptly and fairly.
4646

4747
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
4848

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Four kinds of contribution: **corrections**, **metadata improvements**, **docume
88
2. Open an issue using the *Correction* template.
99
3. Give the current text, your proposed text, and why it is wrong.
1010
4. A validator for that language reviews it. Expect a first response within
11-
[N] working days.
11+
5 working days.
1212

1313
## Contributing new records
1414
New records need more than the text. You must tell us **where it came from** and
@@ -26,4 +26,3 @@ Disagreements between reviewers are escalated and adjudicated rather than averag
2626
Contributors with a track record of accepted contributions can apply.
2727
See `GOVERNANCE.md`.
2828

29-
<!-- TODO: [N] pending; validation-guide.md pending Ngozi -->

GOVERNANCE.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Governance — DRAFT, pending Michael's approval
1+
# Governance
22

3-
Structure from blueprint §7.12.
3+
Structure from .
44

55
## Bodies
66
**Steering Committee** — sets direction, approves policy and roadmap, resolves disputes
@@ -30,4 +30,3 @@ by employment status alone.
3030
Routine changes: maintainer review, two approvals to release.
3131
Policy, licence, or scope changes: Steering Committee, decision recorded publicly.
3232

33-
<!-- TODO Michael: seat counts, terms, how the first committee is seated. -->

HF-DATASET-CARD.md

Lines changed: 0 additions & 116 deletions
This file was deleted.

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
# African Language Parallel Corpus & Validation Toolkit
22

3-
<!-- This file is what a grant reviewer reads first. Lead with what it is,
4-
what state it is in, and how to verify both. No marketing. -->
5-
63
Open parallel-text resources for Yorùbá, Swahili and Nigerian Pidgin, together with the
74
validation tooling and documented review process used to produce them.
85

9-
**Current release:** v1.0 · **DOI:** [TODO] · **Licence:** Apache-2.0 (code) · CDLA-Permissive-2.0 (data) · CC BY 4.0 (docs) — see [LICENSING.md](LICENSING.md)
6+
**Current release:** v1.0 · **Licence:** Apache-2.0 (code) · CDLA-Permissive-2.0 (data) · CC BY 4.0 (docs) — see [LICENSING.md](LICENSING.md)
107

118
| | |
129
|---|---|
@@ -27,22 +24,19 @@ validation tooling and documented review process used to produce them.
2724
| `release/` | Release runbook and manifest format |
2825
| `fixtures/` | Sample records used by tests and documentation |
2926

30-
## Honest status
31-
32-
<!-- Keep this section. It is more persuasive than claiming completeness,
33-
and it is what stops a reviewer catching you out. -->
27+
## Status
3428

35-
**Working today**
36-
- Public versioned corpus release with a citable DOI
29+
**Available now**
30+
- Public versioned corpus release
3731
- Machine-readable record schema, enforced in CI
38-
- Automated checks: schema conformance, Unicode normalisation, duplicate detection
32+
- Automated checks: schema, Unicode normalisation, duplicate detection
3933
- Documented contribution and review process
4034

41-
**Not yet built**
42-
- Language-identity checking — off-the-shelf models are unreliable for these languages
43-
- Provenance and rights classification — vocabulary not yet defined
44-
- Benchmark leakage checking — awaiting the held-out record list
45-
- Web contribution and review interface currently handled through issues and pull requests
35+
**Roadmap**
36+
- Language-identity checking
37+
- Provenance and rights classification
38+
- Benchmark leakage checking
39+
- Web contribution and review interface (currently handled through issues and pull requests)
4640

4741
## Quick start
4842

SECURITY.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33
Do not open a public issue for either of the following.
44

55
**Security** — a vulnerability, exposed credential, or a way to get bad content into a release:
6-
email security@[DOMAIN]. We acknowledge within 2 working days and give a status update
6+
email security@okwu.ai. We acknowledge within 2 working days and give a status update
77
within 10 working days.
88

99
**Rights** — if material here was published without the right to do so:
10-
email rights@[DOMAIN] with the record IDs. We acknowledge within 2 working days.
10+
email rights@okwu.ai with the record IDs. We acknowledge within 2 working days.
1111
Records under dispute are flagged pending review, and retracted with a public notice
1212
if the claim holds.
1313

1414
Supported: the two most recent released versions.
1515

16-
<!-- TODO Hamza: confirm response windows and the mailbox owners before this goes public. -->

0 commit comments

Comments
 (0)