{"id":49780285,"url":"https://github.com/omiq/retrodocs","last_synced_at":"2026-05-11T19:06:09.140Z","repository":{"id":350471134,"uuid":"1206981943","full_name":"omiq/retrodocs","owner":"omiq","description":"Retro Game Coders Documentation Website","archived":false,"fork":false,"pushed_at":"2026-04-27T16:59:17.000Z","size":806,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-27T18:36:58.733Z","etag":null,"topics":["amstrad-cpc","atari","bbc-micro","c64","dragon32","msx","nes","sega","trs80","zx-spectrum"],"latest_commit_sha":null,"homepage":"https://docs.retrogamecoders.com","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/omiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-04-10T13:00:46.000Z","updated_at":"2026-04-27T16:59:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/omiq/retrodocs","commit_stats":null,"previous_names":["omiq/retrodocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/omiq/retrodocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omiq%2Fretrodocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omiq%2Fretrodocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omiq%2Fretrodocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omiq%2Fretrodocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omiq","download_url":"https://codeload.github.com/omiq/retrodocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omiq%2Fretrodocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32908579,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-11T17:09:15.040Z","status":"ssl_error","status_checked_at":"2026-05-11T17:08:45.420Z","response_time":120,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["amstrad-cpc","atari","bbc-micro","c64","dragon32","msx","nes","sega","trs80","zx-spectrum"],"created_at":"2026-05-11T19:06:08.097Z","updated_at":"2026-05-11T19:06:09.132Z","avatar_url":"https://github.com/omiq.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RetroDocs — Retro Game Coders Educational \u0026 Reference Documentation\n\n```\n██████  ███████ ████████ ██████   ██████  ██████   ██████   ██████ ███████ \n██   ██ ██         ██    ██   ██ ██    ██ ██   ██ ██    ██ ██      ██      \n██████  █████      ██    ██████  ██    ██ ██   ██ ██    ██ ██      ███████ \n██   ██ ██         ██    ██   ██ ██    ██ ██   ██ ██    ██ ██           ██ \n██   ██ ███████    ██    ██   ██  ██████  ██████   ██████   ██████ ███████    \n                                                                        \n```\n\n[![CI](https://github.com/omiq/retrodocs/actions/workflows/ci.yml/badge.svg)](https://github.com/omiq/retrodocs/actions/workflows/ci.yml)\n\nPublic repo: **[github.com/omiq/retrodocs](https://github.com/omiq/retrodocs)** — Retro Game Coders documentation (Markdown → static HTML), published at [docs.retrogamecoders.com](https://docs.retrogamecoders.com/).\n\n## Quick start\n\n```bash\ngit clone https://github.com/omiq/retrodocs.git\ncd retrodocs\npython3 -m venv .venv \u0026\u0026 source .venv/bin/activate\npip install -r requirements.txt\nmkdocs serve    # http://127.0.0.1:8000\n```\n\nIf you see a **MkDocs 2.0** warning banner from Material: it is informational, not an error. This repo pins **MkDocs 1.x** in `requirements.txt`. See **Maintaining this site** → *Red “MkDocs 2.0” warning*.\n\n## TRSE reference (auto-generated)\n\nAfter cloning, regenerate method pages from the TRSE tree (requires `resources/text/` next to `retrodocs/`):\n\n```bash\npython3 scripts/import_trse_reference.py --skip-init\n```\n\nCommitted copies may already be present; run the script when you merge TRSE upstream changes.\n\nFor a **standalone** clone, point at a TRSE checkout: `export TRSE_REPO_ROOT=/path/to/trse` (see **`STANDALONE_REPO.md`**).\n\n## Continuous integration\n\nGitHub Actions (`.github/workflows/ci.yml`) runs on pushes and pull requests: clones **[omiq/trse](https://github.com/omiq/trse)** for import scripts, then **`mkdocs build --strict`**. Download the **`site-html`** artifact from a workflow run to inspect the built output.\n\n## Contributing\n\nSee **`CONTRIBUTING.md`**.\n\n## Full maintainer guide\n\nRead **`docs/MAINTAINING.md`** (or view it in the built site under **Maintaining this site**).\n\n## Deploy to a server\n\nFrom `retrodocs/`:\n\n```bash\nexport DEPLOY_USER=you\nexport DEPLOY_HOST=your.server.example\nexport DEPLOY_PATH=/var/www/html/docs\n./deploy.sh\n```\n\nSee comments inside **`deploy.sh`** for SSH keys, dry-run, and safety options.\n\n## Relationship to TRSE\n\nThis tree may live **inside** a TRSE fork or in its **own** GitHub repo. To split it out, see **`STANDALONE_REPO.md`**.\n\n**TRSE’s built-in Help** is not copied here by default — see **`docs/trse/help-import.md`** for a future automated import.\n\nAuto-generated TRSE reference pages need a checkout of **TRSE** (for `resources/text/` and `units/`). Set **`TRSE_REPO_ROOT`** or use **`--repo-root`** when `retrodocs` is not next to those paths — details in **`STANDALONE_REPO.md`**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomiq%2Fretrodocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomiq%2Fretrodocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomiq%2Fretrodocs/lists"}