{"id":49281871,"url":"https://github.com/chenrui333/codex-docs","last_synced_at":"2026-04-25T19:01:48.146Z","repository":{"id":341882766,"uuid":"1162057016","full_name":"chenrui333/codex-docs","owner":"chenrui333","description":"codex docs","archived":false,"fork":false,"pushed_at":"2026-04-22T00:42:24.000Z","size":1101,"stargazers_count":1,"open_issues_count":6,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-22T02:40:14.012Z","etag":null,"topics":["codex","codex-cli","openai"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chenrui333.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-19T20:30:34.000Z","updated_at":"2026-04-22T00:42:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/chenrui333/codex-docs","commit_stats":null,"previous_names":["chenrui333/codex-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/chenrui333/codex-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenrui333%2Fcodex-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenrui333%2Fcodex-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenrui333%2Fcodex-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenrui333%2Fcodex-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chenrui333","download_url":"https://codeload.github.com/chenrui333/codex-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chenrui333%2Fcodex-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32273223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-25T18:29:39.964Z","status":"ssl_error","status_checked_at":"2026-04-25T18:29:32.149Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["codex","codex-cli","openai"],"created_at":"2026-04-25T19:01:47.369Z","updated_at":"2026-04-25T19:01:48.140Z","avatar_url":"https://github.com/chenrui333.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# codex-docs\n\nCommunity-maintained periodic sync for Codex docs, inspired by `claude-code-docs`.\n\nThis repository mirrors Codex-focused content from official OpenAI sources and keeps a lightweight change history so updates are easy to review.\n\n## What gets synced\n\n- `developers.openai.com` Codex pages (`/codex/...`)\n- Codex-related cookbook/resources pages (`/cookbook/...codex...`, `/resources/codex`)\n- Markdown docs from `openai/codex` (README, CHANGELOG, `docs/*.md`, selected CLI/Rust docs)\n- Linked platform tool guides referenced by mirrored Codex docs\n- System skills materialized by the installed Codex CLI\n- A sanitized `codex debug prompt-input` snapshot from the installed Codex CLI\n- A generated `docs/codex_capabilities.json` inventory of mirrored capability surfaces\n\n## Repository layout\n\n- `docs/developers.openai.com/...` mirrored pages from the OpenAI Developers site\n- `docs/github.openai.com/openai/codex/...` mirrored markdown from `openai/codex`\n- `docs/platform.openai.com/...` mirrored linked platform tool guides\n- `dot_codex/skills/dot_system/...` mirrored Codex CLI system skills in installed-path shape\n- `system_prompts/codex-cli/prompt-input.json` sanitized prompt input snapshot from `codex debug prompt-input`\n- `docs/docs_manifest.json` hash manifest for change tracking, including Codex CLI version-history metadata\n- `docs/codex_capabilities.json` generated capability inventory spanning system skills, prompt snapshots, and linked tool guides\n- `docs/sync_summary.json` latest sync summary with the source snapshot for changed outputs\n- `docs/source_coverage.json` sitemap coverage watchdog output\n- `weekly/YYYY-MM-DD.md` digest files with category summary + raw changed paths\n\nGenerated Markdown files include YAML frontmatter with stable source metadata such as `source_type`, `source_area`, `source_url`, upstream `source_last_modified` when available, and `codex_cli_versions` history for the CLI versions where the file remained present.\n\n## Automation\n\nGitHub Actions workflow: `.github/workflows/update-docs.yml`\n\n- Runs every 6 hours\n- Executes `scripts/fetch_codex_docs.py`\n- Commits and pushes when content changes are detected\n- Uploads `docs/source_coverage.json` as a workflow artifact for visibility\n- On sync failure, creates or updates a daily issue with sync summary + log tail\n\nCoverage watchdog behavior:\n\n- Logs codex-related sitemap URL counts and deltas on each run\n- Highlights newly discovered codex-related URLs in workflow logs\n- Optional strict mode: set `CODEX_DOCS_STRICT_COVERAGE=1` to fail when new codex-related URLs are discovered but none are mirrored\n\nResiliency controls:\n\n- `CODEX_DOCS_TIMEOUT_SECONDS` request timeout per call (default `30`)\n- `CODEX_DOCS_MAX_RETRIES` max request attempts (default `3`)\n- `CODEX_DOCS_RETRY_BACKOFF_SECONDS` exponential backoff base (default `1.5`)\n- `CODEX_DOCS_STRICT_SYNC=1` fail the run if any source segment fails (otherwise partial-source runs are allowed and failures are recorded)\n- `just check-strict` runs the idempotence check with strict sync failure enforcement\n\nRelease workflow: `.github/workflows/release.yml`\n\n- Creates a GitHub release from the root `VERSION` file (tag format `vX.Y.Z`)\n- Triggers on `VERSION` changes or manual run via `workflow_dispatch`\n- Keeps direct-push sync model unchanged\n\nOptional helper workflow: `.github/workflows/propose-version-bump.yml`\n\n- Runs monthly (and manual dispatch) to propose a `VERSION` bump PR\n- Skips creating duplicates when an open bump PR with the same title already exists\n\nFeature lifecycle workflow: `.github/workflows/update-feature-flags.yml`\n\n- Runs daily (and manual dispatch) to snapshot current feature flags into `docs/feature-flags/`\n- Uses both `codex features list` and `openai/codex` source files for lifecycle + semantics checks\n- Commits updated snapshots on schedule/manual runs when drift is detected\n- Enforces freshness on pull requests touching feature-flag automation/docs inputs\n\n## Local usage\n\n```bash\njust setup\njust sync\njust check\njust check-strict\njust feature-flags\njust check-feature-flags\n```\n\n## Notes\n\n- This is a community mirror, not an official OpenAI repository.\n- Content attribution remains with the original sources.\n- If a source page structure changes, update `scripts/fetch_codex_docs.py` selectors and filters.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchenrui333%2Fcodex-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchenrui333%2Fcodex-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchenrui333%2Fcodex-docs/lists"}