A template repository for new `living-doc-*` repositories

Open
#135 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
1-2 days
Newbie friendliness
18/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
github, github-actions, python

Research direction

The template is built from living-doc-generator-markdown, so start by reading its CONTRIBUTING.md, Makefile, test.yml, check-pr-requirements.yml, Dependabot config and release-notes config. The work happens in GitHub repository settings, not in this codebase, and needs org permissions and an owner to choose the name. Done means a template repository exists with those files and agd installed, and a new repository can be created from it.

Written by the indexing model from the issue text.

Description

type:tech-debt
Description of Technical Debt

A new repository of the ecosystem is set up by copying files from an existing one. The files are README.md's
skeleton, CONTRIBUTING.md with the rules check-pr-requirements.yml enforces, the test.yml shape with its
docs_changed filter, the Makefile targets (make qa), ruff, Dependabot, pinned third-party actions, the shared
release-notes configuration, and the composite action's venv step. The agent and skill files no longer need copying:
agd installs them in every repository. Only the skeleton remains manual.

Impact of Technical Debt
  • A new repository starts out of line with the rest and drifts.
  • Each copy is chosen from whichever repository was nearest.
Category

DevOps / Infrastructure

Priority

Low - Nice to have

Proposed Solution

A GitHub template repository built from living-doc-generator-markdown, the newest repository, with agd installed. The owner picks its name. Pick it up when the next new repository is planned; the tutorial-capture epic may need one.

Effort Estimate

2 days

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

gh repo list AbsaOSS --limit 300 | grep -i template

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 14m
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc

All issues in AbsaOSS/living-doc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.