{"id":51069527,"url":"https://github.com/ydb-platform/ydb-docs-status","last_synced_at":"2026-06-23T09:32:05.772Z","repository":{"id":364630509,"uuid":"1268622678","full_name":"ydb-platform/ydb-docs-status","owner":"ydb-platform","description":null,"archived":false,"fork":false,"pushed_at":"2026-06-13T19:22:58.000Z","size":206,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-13T21:18:01.855Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ydb-platform.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-06-13T18:45:17.000Z","updated_at":"2026-06-13T19:23:01.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ydb-platform/ydb-docs-status","commit_stats":null,"previous_names":["ydb-platform/ydb-docs-status"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ydb-platform/ydb-docs-status","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydb-platform%2Fydb-docs-status","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydb-platform%2Fydb-docs-status/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydb-platform%2Fydb-docs-status/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydb-platform%2Fydb-docs-status/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ydb-platform","download_url":"https://codeload.github.com/ydb-platform/ydb-docs-status/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydb-platform%2Fydb-docs-status/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34684673,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-23T02:00:07.161Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-23T09:32:05.672Z","updated_at":"2026-06-23T09:32:05.767Z","avatar_url":"https://github.com/ydb-platform.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ydb_ru_eng_sync\n\nCompares the Russian and English versions of the [YDB](https://ydb.tech)\ndocumentation across multiple product versions. Each page gets a score\nfrom 1 to 10: 1 means the page is missing on one side or differs sharply,\n10 means the two versions are nearly identical.\n\nGenerated reports are published to GitHub Pages (see below).\n\n## Requirements\n\n- Python 3.10+\n- `git` 2.25+ (needs `sparse-checkout` and `--filter=blob:none`)\n- Outbound internet access to `github.com`\n\n## Quick start\n\n```bash\n./download.py     # fetch docs for every version from ydb-platform/ydb into cache/\n./analyze.py      # compare ru/en, build reports under docs/\n```\n\nOpen the result locally:\n\n```bash\nopen docs/index.html             # landing: links to summary and history\nopen docs/summary.html           # convenient entry point: all versions\nopen docs/main/report.html       # per-version detail\n```\n\nIf you change the methodology (weights, patterns), no network is needed:\n\n```bash\n./analyze.py      # recompute against the docs already in cache/\n```\n\n## What's in the repository\n\n```\nydb_ru_eng_sync/\n├── README.md\n├── CLAUDE.md\n├── config.json                 # version registry and shared settings\n├── download.py                 # entry point: fetch docs into cache/\n├── analyze.py                  # entry point: archive → compare → report → summary → index\n├── scripts/                    # implementation (fetch, compare, report, summary, archive, index, lib)\n├── documentation/              # internal project docs (for developers)\n├── cache/                      # (gitignored) fetched YDB docs\n└── docs/                       # COMMITTED — root of the GH Pages site\n    ├── index.html              # landing\n    ├── summary.{html,txt}      # current cross-version summary\n    ├── \u003cv\u003e/                    # current per-version report\n    └── history/\u003cYYYY-MM-DD\u003e/   # archive of previous snapshots\n```\n\nTwo \"docs\" folders at the root — they are not duplicates:\n\n| Folder | Contents |\n| --- | --- |\n| `docs/` | Generated HTML site, root of GitHub Pages. **Committed.** |\n| `documentation/` | Internal Markdown about the project (architecture, recipes, module reference) — read by humans, not published. |\n\nThe heavy fetched `cache/\u003cv\u003e/docs/` (~100 MB × N versions) is excluded\nby `.gitignore` and rebuilt by `./download.py`.\n\n## Report history\n\n`docs/meta.json` stores the date of the last run. On every\n`./analyze.py` run:\n\n1. If the date in `meta.json` differs from today, the current snapshot\n   under `docs/` (excluding `history/` and `index.html`) is copied into\n   `docs/history/\u003cold_date\u003e/`.\n2. `docs/\u003cv\u003e/...`, `docs/summary.*`, and `docs/index.html` are\n   regenerated.\n3. `docs/meta.json` is rewritten with the new date.\n\nMultiple runs in the same day overwrite that day's folder — only the\nlast snapshot of the day is kept. Every report (`summary.html`,\n`\u003cv\u003e/report.html`) carries a \"Generated: …\" line in its header.\n\n## Team workflow\n\nFor any team member:\n\n```bash\ngit pull\n./download.py            # pull updates (mainly main and stable-*)\n./analyze.py             # rebuild reports\ngit add docs             # docs/ is committed; cache/ is not\ngit commit -m \"docs: snapshot $(date +%Y-%m-%d)\"\ngit push\n```\n\nAfter the push, GitHub Pages refreshes the site automatically (see below).\n\nTo see exactly what changed in the reports:\n\n```bash\ngit diff --stat docs/\ngit diff docs/summary.txt    # the txt variants are easy to review via git diff\n```\n\n## GitHub Pages\n\nOne-time setup for the repository owner:\n\n1. **Settings → Pages**.\n2. **Source**: *Deploy from a branch*.\n3. **Branch**: `main`, **Folder**: `/docs`.\n4. Save.\n\nNo GitHub Actions involved — Pages serves the contents of `docs/`\ndirectly from the `main` branch. The site URL appears in the same\nsettings page.\n\n## Add a new YDB version\n\n1. Open [`config.json`](config.json) and add an entry under `\"versions\"`:\n   ```json\n   \"26.2\": {\"ref\": \"stable-26-2\", \"url_version\": \"v26.2\"}\n   ```\n2. Run:\n   ```bash\n   ./download.py 26.2\n   ./analyze.py\n   ```\n\n## Fine-tuning\n\n- `./download.py \u003cv\u003e...` / `./analyze.py \u003cv\u003e...` — work on a subset of versions.\n- `./download.py --refresh \u003cv\u003e` — force re-fetch (needed when `main` moves or `stable-*` gets a hotfix).\n- The individual stages can be called directly via `scripts/fetch.py`,\n  `scripts/compare.py`, `scripts/report.py`, `scripts/summary.py`,\n  `scripts/archive.py`, `scripts/index.py` — each has `--help`.\n\n## Project documentation\n\n- [documentation/architecture.md](documentation/architecture.md) — system layout, data flow.\n- [documentation/scoring.md](documentation/scoring.md) — scoring methodology, weights, limitations.\n- [documentation/howto.md](documentation/howto.md) — common recipes.\n- [documentation/modules.md](documentation/modules.md) — function- and module-level reference.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydb-platform%2Fydb-docs-status","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fydb-platform%2Fydb-docs-status","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydb-platform%2Fydb-docs-status/lists"}