{"id":28507956,"url":"https://github.com/corridor/ggx-docs","last_synced_at":"2025-07-02T06:31:42.536Z","repository":{"id":296829908,"uuid":"993657587","full_name":"corridor/ggx-docs","owner":"corridor","description":"Documentation for GGX","archived":false,"fork":false,"pushed_at":"2025-06-02T08:51:17.000Z","size":61750,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-02T19:51:08.627Z","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/corridor.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}},"created_at":"2025-05-31T08:26:05.000Z","updated_at":"2025-06-02T08:51:21.000Z","dependencies_parsed_at":"2025-06-02T20:08:56.352Z","dependency_job_id":null,"html_url":"https://github.com/corridor/ggx-docs","commit_stats":null,"previous_names":["corridor/ggx-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/corridor/ggx-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corridor%2Fggx-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corridor%2Fggx-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corridor%2Fggx-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corridor%2Fggx-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/corridor","download_url":"https://codeload.github.com/corridor/ggx-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/corridor%2Fggx-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263086577,"owners_count":23411738,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2025-06-08T21:07:22.377Z","updated_at":"2025-07-02T06:31:42.528Z","avatar_url":"https://github.com/corridor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Corridor Documentation\n\n## Pre-requisites\n\n- Python 3.10+\n- Weasyprint: \u003chttps://weasyprint.readthedocs.io/en/stable/install.html\u003e\n    - In Mac: `brew install cairo pango gdk-pixbuf libffi`\n    - In Ubuntu: `sudo apt-get install build-essential libcairo2 libpango-1.0-0 libpangocairo-1.0-0 libgdk-pixbuf2.0-0 libffi-dev shared-mime-info`\n\n## Setup Summary\n\nTo run a mkdocs server, run:\n\n    # Install python deps\n    uv venv venv --python 3.11 --seed\n    uv pip install -r requirements.txt --python venv\n\n    # Install JS deps -- for prettier formatting\n    npm install -g pnpm@9\n    pnpm i\n\nAfter installation, you can serve mkdocs directly with:\n\n    # Serve mkdocs directly\n    venv/bin/mkdocs serve\n\nand then access the docs at \u003chttp://localhost:8000\u003e\n\nOr you can also run corridor-docs directly:\n\n    # Run corridor-docs locally\n    venv/bin/corridor-docs run\n\n## Guidelines on Writing\n\n- Avoid using \"the platform\" and instead use \"Corridor\" so readers are clear on what is being said\n- Run grammarly on the content to fix any grammar issues and typos\n    - Grammarly changes whitespaces to a different ascii space. So, need to do a find replace to bring back spaces correctly, otherwise markdown renderers don't work\n    - Grammarly messes up the formatting for admonitions like `!!!note`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorridor%2Fggx-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcorridor%2Fggx-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcorridor%2Fggx-docs/lists"}