Let a pipeline set the document version
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Feature
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- python
- Domain
- cli, documentation
Research direction
Start by reading action.yml, the normalize-docs action implementation, and docs/action.md; trace how the action passes --document-version to generator-ready. Add the proposed input and document it. Done when a pipeline can set the document version and the published document header uses it instead of the default.
Written by the indexing model from the issue text.
Description
Description of Technical Debt
generator-ready's required document.version comes from --document-version and defaults to 1.0.0. The action
has no input for it, so every technical project a pipeline builds says "version 1.0.0", and
living-doc-generator-markdown prints that in the header.
Impact of Technical Debt
- Published documents carry a version that means nothing.
Category
Code Quality / Refactoring
Priority
Low - Nice to have
Proposed Solution
A document-version input passed to normalize-docs, documented in docs/action.md. Pick it up when a pilot publishes a release document, or someone asks for the real version.
Effort Estimate
2 hours
Dependencies / Related
No response
Additional Context
Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0). Re-check:
grep -n document-version action.yml is empty while this is open.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 19
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from AbsaOSS/living-doc-toolkit
-
tech debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
AbsaOSS/living-doc-toolkit#120 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 Half a day Newbie friendliness 84/100
AbsaOSS/living-doc-toolkit#118 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
AbsaOSS/living-doc-toolkit#116 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 4/5 1-2 days Newbie friendliness 55/100
AbsaOSS/living-doc-toolkit#119 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 5/5 Over a week Newbie friendliness 25/100
AbsaOSS/living-doc-toolkit#117 ·
Maintainers usually reply within 1 day
All issues in AbsaOSS/living-doc-toolkit
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
deepchem/deepchem#5289 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
UKGovernmentBEIS/inspect_evals#2892 · 1 comment ·
Maintainers usually reply within 1 day
-
Versioning docs: say that no output from the 0.46 warning check means nothing is affectedPossibly taken @grelinfo claimed this today. Opendocumentation priority:low size:S
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
alphacrack/readme2demo#293 ·