Documentation Question - Most recent changes

25 views
Skip to first unread message

driskel

unread,
Sep 24, 2016, 2:18:35 PM9/24/16
to MPF Users
I am trying to find the most recent changes and additions to the documentation site.

Is there a feature that you could enable that would show the history of changes in 1 page, that you could navigate to that page from?

Thank you.

Brian Madden

unread,
Sep 24, 2016, 9:15:13 PM9/24/16
to MPF Users
That would be cool.

Since the documentation lives in a GitHub repository, you can view history and changes there.

To see the history of a single page, click the "Edit on GitHub" link in the upper right corner of any page. That will take you directly to that page in the GitHub repo. Then you can click the "History" button in the corner of the document frame to to see all the commits that included changes to that page. From there you can click the button with the < > on it to go to the page as it was then. You can also click the title of the doc itself to see what the changes were (red highlights are deletes, green highlights are additions).

If you want to see a list of all changes across all docs on the site, you can view the latest commits (changes) to the repo on the repo's "commits" page:
https://github.com/missionpinball/mpf-docs/commits/0.31

Substitute the "0.31" at the end of the URL for the current version of MPF if you're reading this post in the future. We try to make the commit titles somewhat explanatory (other than simple typos which are just labeled as "typo.")

So I know this isn't super ideal, but it's the best we have now.

The documentation is hosted on a service called Read the Docs (https://readthedocs.org/) which is community-supported documentation hosting. There might be more options there if you want to look into that or Google around a bit? We'd welcome any help making the documentation more useful!

Brian

driskel

unread,
Sep 25, 2016, 11:31:52 AM9/25/16
to MPF Users
Thanks, Brian, 

Yes, I understand the git side of things.  Thinking more as a useful page as a log of change pages in order. 

driskel

unread,
Sep 25, 2016, 11:39:23 AM9/25/16
to MPF Users
And no worries.  

Thank you for all that you and the team have done.
Reply all
Reply to author
Forward
0 new messages