scala-native icon indicating copy to clipboard operation
scala-native copied to clipboard

doc: ReadTheDocs site ReadMe needs "Document built" and "Topic last updated" info

Open LeeTibbert opened this issue 1 year ago • 0 comments

The places where people encounter Scala Native for the first time, or the first time in awhile, need to be especially encouraging and inviting.

The fact that there is a readily accessible ReadTheDocs web for SN 0.5.0-SNAPSHOT is good. The relatively recent (months old) change to put the git last modification time on each page was a step forward. It gives users some idea of how old a page is. Older pages may not describe current behavior.

The index page of the website gives the modification date of the ReadMe.md file not the date of publication to the web site. I believe that both are needed in order to give the reading better context.

Currently, the (landing page)[https://scala-native.org/en/latest/index.html#] unflatteringly gives Last updated: 2023-10-09 12:23:29.

That makes it looks like the doc set has not been updated in over 4 months. That is not true, since the page I was actually interested in was dated in February, 2024

(contrib quickstart)[https://scala-native.org/en/latest/contrib/quickstart.html#requirements] has an additional `Document built' line.

Last updated: 2023-10-02 22:49:32.

Document built: Feb 16, 2024

Perhaps we need something on the landing page (at least) something like:

Document built: Feb 16, 2024
Topic last updated: 2023-10-02 22:49:32.

I know that would increase my confidence as a reader that I was getting current information.

This can get fixed up after 0.5.0-RC1.

LeeTibbert avatar Feb 16 '24 17:02 LeeTibbert