{"id":30325824,"url":"https://github.com/ickc/gen-doc","last_synced_at":"2026-02-11T11:03:45.591Z","repository":{"id":305129655,"uuid":"810473676","full_name":"ickc/gen-doc","owner":"ickc","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-24T14:12:37.000Z","size":147,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-21T21:27:34.691Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://chatgpt.com/g/g-eLbHOUnhU-documentation-consultant","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ickc.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}},"created_at":"2024-06-04T19:08:15.000Z","updated_at":"2025-09-24T14:12:42.000Z","dependencies_parsed_at":"2025-07-18T13:53:24.606Z","dependency_job_id":"aa374321-16eb-4f1a-b67e-d250d3fb70a2","html_url":"https://github.com/ickc/gen-doc","commit_stats":null,"previous_names":["ickc/gen-doc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ickc/gen-doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickc%2Fgen-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickc%2Fgen-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickc%2Fgen-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickc%2Fgen-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ickc","download_url":"https://codeload.github.com/ickc/gen-doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ickc%2Fgen-doc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29332292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"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":[],"created_at":"2025-08-17T23:08:16.525Z","updated_at":"2026-02-11T11:03:45.584Z","avatar_url":"https://github.com/ickc.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"This builds single file targets from documentations, primarily for the purpose of feeding into LLMs to chat with doc.\n\n# Notes\n\nEach subdirectories should contains a single documentation project. Within each, it must contains\n\n- `makefile` with targets `single_file`, `all`, `clean`, `Clean`, `update`.\n\n    - `single_file` should make the best single file target, and make a copy at `build/` with the name of that subdirectory and an appropriate extension.\n\n    - `all` make all single file targets, including `single_file` and optionally other alternative single file targets.\n\n    - `clean` cleanup generated files.\n\n    - `Clean` is a more thorough cleanup, including other things that are more expensive to generate such as the environment.\n\n    - `update` will update the doc to point to the latest one, and also the environment if present.\n\n- `.gitignore`\n\n- optionally `README.md`\n\n# Tips and examples\n\nSome patterns in creating single file documentations are discussed below.\n\n## Submodules\n\nUsually we are manipulating from the source of a repository. In that case, add it as a submodule to track it first:\n\n```bash\ngit submodule add URL PROJECT/git\n```\n\n## Environments\n\nUsually the environment to build a doc is non-trivial. In that case, a reproducible environment should be included, such as via pixi.\n\nIn some cases, tools involve is commonly available on UNIX and hence a custom environment is not created.\n\n## Patterns\n\n### Simply Download\n\nExamples: `pandoc`, `Pkg.jl`\n\n### Simply concat\n\nIn some cases, the documentation framework used in a project does not have an option to produce single file documentation. We will then simply concat all relevant doc files and call it a day.\n\nExamples: `devbox`, `flox`\n\n### Crawl \u0026 concat\n\nSome projects doesn't even provide the source of documentation. We will use this recipe instead:\n\n1. crawl by wget\n2. convert to markdown by pandoc\n3. concat\n\nPrevious example: [`flox`](https://github.com/ickc/gen-doc/blob/416d3a941537cd767a63900b3dde5f72ba0f82c6/flox/makefile)\n\n### Simply build\n\nWe will use the original build system to produce a single file target that is not provided.\n\nExamples: `python-patterns`, `gw4-isambard`, `spack` with sphinx\n\n### Tweak \u0026 rebuild\n\nWe would dive into the doc build framework and tweak it so that single file target are produced.\n\nExamples:\n\n- `nersc`, `pixi` with mkdocs and additional plugin `print-site`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fickc%2Fgen-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fickc%2Fgen-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fickc%2Fgen-doc/lists"}