Skip to content
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

Proposal: Remove the "Date last updated" title in docs #572

Open
alaurie opened this issue Jan 23, 2025 · 1 comment
Open

Proposal: Remove the "Date last updated" title in docs #572

alaurie opened this issue Jan 23, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@alaurie
Copy link
Contributor

alaurie commented Jan 23, 2025

I propose we eliminate the 'Date Last Updated' section from our documentation. I've observed that in several documents, updates are made without corresponding changes to the last updated date. This date isn't automatically updated; it requires manual adjustment, which is often overlooked. Moreover, we can always retrieve this information from Git history if needed.

Including dates in our documents might give the impression that they are outdated if not frequently refreshed, which could affect user perception negatively, even when the content remains valid.

If there's a consensus that we should retain this information, I suggest we include it as a markdown comment, so it doesn't appear in the rendered wiki version:

<!-- Date Last Updated: [Insert Date Here] -->

This approach ensures the date is available for those who need it without impacting the document's appearance to end users.

@bennyvasquez bennyvasquez added the enhancement New feature or request label Jan 23, 2025
@bennyvasquez
Copy link
Member

@sboldyreva I can't actually remember when/why we added those, but I like them because I sincerely hate having to guess about whether or not a document is up to date. There might be another/better way to accomplish the same thing, and/or I might be in the minority here. :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants