You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
@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
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.
The text was updated successfully, but these errors were encountered: