Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# SDMX Information Model

This submodule contains the SDMX Information Model, Framework, Logical
Interfaces, and Technical Notes documentation components used within the
[`sdmx-docs`](https://github.com/sdmx-twg/sdmx-docs) unified documentation
site.

## Repository Structure

- `docs/` — content pages, organised into four sub-folders:
- `docs/framework/`
- `docs/information_model/`
- `docs/logical_interfaces/`
- `docs/technical_notes/`

| File | Section served |
| ------------------------------- | ------------------------------ |
| `mkdocs_framework.yml` | Section 1 — Framework |
| `mkdocs_information_model.yml` | Section 2 — Information Model |
| `mkdocs_logical_interfaces.yml` | Section 5 — Logical Interfaces |
| `mkdocs_technical_notes.yml` | Section 6 — Technical Notes |

## Version Branches

Each release of this component is maintained on a dedicated branch following the
pattern `X.Y.x` (e.g., `3.1.x`). The branch tracked by the
[`sdmx-docs`](https://github.com/sdmx-twg/sdmx-docs) parent repository is
declared in `.gitmodules` at the root of that repo. Switching the tracked branch
in the parent repository is how a new version of this component is published on
the documentation site.

## Formatting Conventions

For Markdown and MkDocs formatting conventions that apply to content in `docs/`,
see the [`sdmx-docs` README](https://github.com/sdmx-twg/sdmx-docs#readme).