{"id":51856278,"url":"https://github.com/ellmos-ai/project-docs-template","last_synced_at":"2026-07-24T01:03:47.732Z","repository":{"id":368744577,"uuid":"1273860669","full_name":"ellmos-ai/project-docs-template","owner":"ellmos-ai","description":"Agent-ready project documentation template with START/STATE/TODO/DONE, workflows, lightweight tooling, and LLM-friendly project memory.","archived":false,"fork":false,"pushed_at":"2026-07-17T03:52:00.000Z","size":77,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-07-17T05:28:42.930Z","etag":null,"topics":["agent-ready","agent-workflow","claude-code","codex","documentation-template","documentation-tools","ellmos","llm-agents","llm-documentation","project-docs","project-template"],"latest_commit_sha":null,"homepage":"https://github.com/ellmos-ai/project-docs-template#readme","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/ellmos-ai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":null,"dco":null,"cla":null},"funding":{"custom":["https://paypal.me/lukasgeiger2507"]}},"created_at":"2026-06-19T00:16:35.000Z","updated_at":"2026-07-17T03:52:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ellmos-ai/project-docs-template","commit_stats":null,"previous_names":["ellmos-ai/project-docs-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/ellmos-ai/project-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellmos-ai%2Fproject-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellmos-ai%2Fproject-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellmos-ai%2Fproject-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellmos-ai%2Fproject-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ellmos-ai","download_url":"https://codeload.github.com/ellmos-ai/project-docs-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ellmos-ai%2Fproject-docs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35822076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-23T02:00:06.683Z","response_time":57,"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":["agent-ready","agent-workflow","claude-code","codex","documentation-template","documentation-tools","ellmos","llm-agents","llm-documentation","project-docs","project-template"],"created_at":"2026-07-24T01:03:47.194Z","updated_at":"2026-07-24T01:03:47.689Z","avatar_url":"https://github.com/ellmos-ai.png","language":"Python","funding_links":["https://paypal.me/lukasgeiger2507"],"categories":[],"sub_categories":[],"readme":"# Project Docs Template\n\n[![Template](https://img.shields.io/badge/template-agent--ready_project_docs-2f6f5e)](https://github.com/ellmos-ai/project-docs-template)\n[![CI](https://github.com/ellmos-ai/project-docs-template/actions/workflows/ci.yml/badge.svg)](https://github.com/ellmos-ai/project-docs-template/actions/workflows/ci.yml)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\n\nAgent-ready project documentation template with START/STATE/TODO/DONE,\nworkflows, lightweight tooling, and LLM-friendly project memory.\n\nThis repository contains a compact documentation scaffold for projects that are\nmaintained with LLM agents. The template focuses on clear project state,\nsession handoff, task history, decision records, workflows, and small local\nutilities without turning the project into a heavy operating system.\n\n## Use This Template When\n\n| Situation | Why it helps |\n|---|---|\n| A new project will be maintained by Claude Code, Codex, Gemini CLI, or another coding agent | Gives the agent a predictable bootstrap path and current-state file. |\n| An existing repo has scattered notes, stale task files, or no handoff trail | Separates active work, completed work, decisions, patterns, and session state. |\n| Multiple agents or humans need to resume work safely | Keeps instructions, current state, workflows, and tools in distinct files. |\n\nThis is a documentation and coordination template, not a runtime framework. It\nis meant to sit inside ordinary software, research, or operations repositories.\n\n## What Is Included\n\n- `CLAUDE.md` and `AGENTS.md` for agent instructions\n- `START.md` and `STATE.md` for session bootstrap and current state\n- `TODO.md` and `DONE.md` with optional archival tooling\n- `DECISIONS.md`, `PATTERNS.md`, `CHANGELOG.md`, and `HEADER-RULES.md`\n- Optional FULL-profile routers: `WORKFLOWS.md`, `TOOLS.md`, `GLOSSARY.md`\n- Local helpers in `_tools/`, including `init-project`, `doc-lint`,\n  `todo-archive`, and `workflows-sync`\n\nThe actual template files live in [`template/`](./template/).\n\n## Quick Start\n\nClone this repository and instantiate a project profile:\n\n```bash\ngit clone https://github.com/ellmos-ai/project-docs-template.git\ncd project-docs-template\npython template/_tools/init-project --target ../my-project --name MyProject --profile STANDARD\n```\n\nAdd `--author \"Your Name\"` to set explicit frontmatter ownership or `--git` to\ncreate a `main` repository and initial commit. Without `--author`, the tool uses\n`git config user.name` and then the local OS account as a safe fallback.\n\nGeneration is staged beside the target. The result is promoted only after its\nprofile markers, generator-owned placeholders, and relative Markdown links\nhave been validated. Existing non-empty targets are never overwritten.\n\nAvailable profiles:\n\n- `MINIMAL`: 7 root files plus essential tools\n- `STANDARD`: 12 root files plus essential tools\n- `FULL`: 16 root files plus workflow, tool, GitHub, and glossary scaffolding\n\nYou can also copy files manually from [`template/`](./template/) if you only\nneed selected pieces.\n\nRequires Python 3.10 or newer. Git is required only for `--git`.\n\n## Profile Comparison\n\n| Profile | Best for | Files copied |\n|---|---|---|\n| `MINIMAL` | Small repos, experiments, short-lived tools | Core agent instructions, start/state, TODO/DONE, essential tools |\n| `STANDARD` | Serious projects with decisions and recurring maintenance | Minimal set plus changelog, decisions, patterns, header and cut-and-clue rules |\n| `FULL` | Multi-agent or long-running projects with routers and workflows | Standard set plus architecture, workflow/tool routers, glossary, `.github/` |\n\n## Design Principles\n\n- Every file has a distinct job.\n- Session handoff is explicit and short.\n- Maintenance burden matters more than having every possible document.\n- Routers such as `WORKFLOWS.md` and `TOOLS.md` point to details elsewhere.\n- Completed tasks can be archived automatically instead of bloating `TODO.md`.\n\nSee [`template/TEMPLATE.md`](./template/TEMPLATE.md) for the full rationale and\nfile-by-file explanation.\n\n## Verification\n\n```bash\npython -m unittest discover -s tests -v\n```\n\nThe suite exercises every profile, real Git initialization, frontmatter\nrepair, workflow metadata escaping, and TODO/DONE rollback behavior. The same\nsuite runs on Linux, Windows, and macOS; see [`RELEASE_GATE.md`](./RELEASE_GATE.md).\n\nSecurity reports belong in the private channel described in\n[`SECURITY.md`](./SECURITY.md), not in public issues.\n\n## Discoverability\n\nCanonical search phrases:\n\n```text\nagent-ready project documentation template\nLLM project docs template START STATE TODO DONE\nClaude Code Codex project documentation scaffold\nmulti-agent repo handoff documentation template\n```\n\nFor LLM and crawler-oriented metadata, see [`llms.txt`](./llms.txt).\n\n## License\n\nMIT License. See [LICENSE](./LICENSE).\n\nThis project is an unpaid open-source donation. Liability is limited to intent\nand gross negligence under Section 521 of the German Civil Code. Use at your\nown risk. No warranty, maintenance guarantee, availability guarantee, or\nfitness-for-purpose guarantee is provided.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fellmos-ai%2Fproject-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fellmos-ai%2Fproject-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fellmos-ai%2Fproject-docs-template/lists"}