Skip to content

Amortize project metadata out of individual files #824

@sawatts

Description

@sawatts

Problem Description

Making a small code change and updating the documentation; the PR goes from one source code file, to hundreds of HTML files - each of which has the project version in the embedded footer updated.

This is really unnecessary.

Proposal

Extract the footer into a separate file and include it in each page, rather than copying it verbatim. When the project version changes, only the footer needs to be updated - a single file in the PR, not hundreds.

The same approach may be applied to other project metadata which does not directly relate to the documentation being generated.

Alternatives

Put project metadata in a file which can be accessed by a script and used to populate fields in each page. The metadata source can change, but the pages themselves become static unless there is an actual documentation change.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions