Unify card: Open-Telco Telecom Standards Corpus

README.md

@@ -1,11 +1,15 @@
 ---
 license: other
+license_name: o-ran
+license_link: https://www.o-ran.org/
 language:
 - en
+pretty_name: O-RAN ALLIANCE Specifications
 tags:
+- telecommunications
 - oran
-- telecom
-- specifications
+- standards
+- open-telco
 size_categories:
 - n<1K
 configs:
@@ -61,6 +65,9 @@ configs:
 
 # O-RAN source mirror
 
+> Part of the **[Open-Telco Telecom Standards Corpus](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf)**.  
+> Sibling mirrors: [3GPP](https://huggingface.co/datasets/GSMA/3GPP) · [ETSI](https://huggingface.co/datasets/GSMA/etsi) · [ITU-T](https://huggingface.co/datasets/GSMA/itu) · **O-RAN** · [GSMA](https://huggingface.co/datasets/GSMA/gsma) · [TM Forum](https://huggingface.co/datasets/GSMA/tmforum) · [CAMARA](https://huggingface.co/datasets/GSMA/camara)
+
 This dataset mirrors the O-RAN ALLIANCE's published specifications and technical reports. Every source is kept twice: `original/` is the document as O-RAN released it (PDF and Word), and `marked/` is that same document converted to Markdown for search and retrieval, one `raw.md` per document with any figures extracted beside it. The two trees share identical paths, so a file in `original/` has a parsed twin at the matching path under `marked/`; both are grouped by O-RAN ALLIANCE working group (WG1 through WG11, plus the focus groups SFG, SuFG, and TIFG). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
 
 ```text
@@ -72,3 +79,28 @@ oran/
   manifest.jsonl    # one row per file: path, sha256, parse status
   STATUS.md         # parse-coverage summary
 ```
+
+## How it is organized
+
+- `original/` holds the specifications and technical reports as the O-RAN ALLIANCE published them (PDF and Word), grouped by working group (WG1 through WG11, plus the focus groups SFG, SuFG, and TIFG).
+- `marked/` is the Markdown twin of `original/` at identical paths, one `raw.md` per document with figures beside it.
+- `manifest.jsonl` carries one row per file (path, SHA-256, parse status); `STATUS.md` reports parse coverage.
+
+## How to use
+
+Pull only the Markdown twins (skip the heavy `original/` tree) and read them straight:
+
+```python
+from huggingface_hub import snapshot_download
+
+path = snapshot_download("GSMA/oran", repo_type="dataset", allow_patterns="marked/**")
+# every parsed document is a marked/**/raw.md
+```
+
+## The corpus
+
+This dataset is part of the **Open-Telco Telecom Standards Corpus**, an effort to make telecommunications open by mirroring every major standards body into clean, machine-readable Markdown. The full set: 3GPP, ETSI, ITU-T, O-RAN, GSMA, TM Forum, and CAMARA. Browse them all in the [collection](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf).
+
+## License and attribution
+
+The mirrored documents remain the property of the O-RAN ALLIANCE and stay subject to its terms; see [www.o-ran.org](https://www.o-ran.org/). This dataset reproduces them in original and Markdown form for research, search, and retrieval. Cite the underlying specification by its O-RAN document number when you use it.