Tool for determining which documentation pages are relevant for branch
With the new documentation metadata, each page should contain information on which files they describe. To make it easier to keep the documentation up to date, we want a tool that, for a given branch, gives a list of affected documentation pages, to check whether they need to be updated.
-
Move to BatCat?
To Do:
-
Write Tool for converting metadata to index -
Write/Update index for mapping and for upcoming reviews
-
-
Get commits which are specific to the branch currently checked out (all commits since branching except those from merges?) -
List all files changed in these commits -
Determine which documentation pages are affected, either through a check against local copy of docs, or more likely by an index somewhere (try to get from docs@dev?) -
Output -
maybe including suggested md-snippets from changelog
-
-
Document needed documentation metadata (maybe path@project, so "src/folder/file@linkahead-pylib"?) and workflows both in docs and other repos -
Add to makefiles?
-
-
Write up suggestion for review cycle, add review data including quality assessment to metadata -
Followup: -
Issues?
-
Edited by I. Nüske