Skip to content

[Feature Request]: Show last update date timestamp #1075

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
2 tasks done
theletterf opened this issue Apr 10, 2025 · 3 comments
Open
2 tasks done

[Feature Request]: Show last update date timestamp #1075

theletterf opened this issue Apr 10, 2025 · 3 comments
Assignees

Comments

@theletterf
Copy link
Contributor

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

It would be good to show the last update date of each document, based on Git timestamps. For example:

Image

Proposed Solution

  • Collect the git history at build.
  • Produce the timestamp for each built document based on the git timestamp.

Not sure how this would work for reference docs though.

Examples and Research

MkDocs and others do it based on git information: https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-dates

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Nice to have

@theletterf theletterf self-assigned this Apr 10, 2025
@theletterf
Copy link
Contributor Author

+CC @bmorelli25 @alaudazzi

@KOTungseth
Copy link
Contributor

KOTungseth commented Apr 10, 2025

Prior art (but for AsciiDoc)

Seal of freshness

Notes I've collected along the way

Definitions:

  • Last edited date: Ran through linting (probably Acrolinx and received 80% proficiency score)
  • Last validated date: Reviewed by SME, QA, or Dev that created the feature/capability

Possible process:

  • Checklist for PR validation
  • Create schedule for making sure docs are not stale
  • How often Docs need to be validated? Run a search?

Open questions:

  • If we don't retroactively implement changes, would it be weird to have these dates at the top of some docs, but not all?
  • Automatically add via v3 or rely on authors to add?

@reakaleek
Copy link
Member

Related #1127

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants