emolero commited on
Commit
b38fa2e
·
verified ·
1 Parent(s): 58be94e

docs: README file-map for v2.0-only layout (apis/ + components/)

Browse files
Files changed (1) hide show
  1. README.md +9 -7
README.md CHANGED
@@ -11,14 +11,16 @@ tags:
11
 
12
  # TM Forum source mirror
13
 
14
- This dataset mirrors TM Forum's Open APIs, ODA component specifications, and programme documents. Every source is kept twice: `original/` is the file as TM Forum released it (OpenAPI YAML, Swagger JSON, and PDF/Word), and `marked/` is that same file 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 TM Forum programme area (Open_API, ODA, Autonomous_Networks, Intent, and the conformance test kits). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
15
 
16
  ```text
17
  tmforum/
18
- original/ # source files as published, by programme area
19
- Open_API/ ODA/ Autonomous_Networks/ Intent/ ...
20
- marked/ # Markdown mirror of original/, same paths
21
- Open_API/.../raw.md # one per document, images beside it
22
- manifest.jsonl # one row per file: path, sha256, parse status
23
- STATUS.md # parse-coverage summary
 
 
24
  ```
 
11
 
12
  # TM Forum source mirror
13
 
14
+ This dataset holds TM Forum's Open API specifications and ODA component definitions, the set TM Forum publishes for open digital architecture. Every source is kept twice: `original/` is the file as TM Forum released it (`apis/` holds the OpenAPI and Swagger specs, `components/` holds the ODA component YAML), and `marked/` is that same file converted to Markdown for search and retrieval, one `raw.md` per file at the matching path. `manifest.jsonl` carries one row per file (path, SHA-256, parse status) and `STATUS.md` reports how much of the corpus has been parsed.
15
 
16
  ```text
17
  tmforum/
18
+ original/
19
+ apis/ # OpenAPI / Swagger specs (TMF6xx, TMF9xx)
20
+ components/ # ODA component definitions (TMFC0xx)
21
+ marked/ # Markdown mirror of original/, same paths
22
+ apis/<spec>/raw.md
23
+ components/<component>/raw.md
24
+ manifest.jsonl # one row per file: path, sha256, parse status
25
+ STATUS.md # parse-coverage summary
26
  ```