SSK2: Documentation issues

Other Third-Party Tools
#1

Low priority minor issues.

For those of us using a MacAir, the table of contents doesn’t scroll. The right window does, the left does not.

In the display object factories page there is a broken link.

Page: https://roaminggamer.github.io/RGDocs/pages/SSK2/libraries/display_standard/

Link from here:  "Note:  Only works if enableAutoListeners = true. See Configuring SSK2."

Link is: "https://roaminggamer.github.io/RGDocs/pages/SSK2/quick_start/#configuring-ssk-2"

Link should be: "https://roaminggamer.github.io/RGDocs/pages/SSK2/#configuring-ssk2"

#2

@Graham07,

Noted.  

Broken Link

I’ll fix that shortly.

Scrolling

This may take a bit longer.

To produce these docs I am using MkDocs  with the ‘Cinder’ theme.

I’ve tried all of the the public themes and this seems to be the most legible and easy to navigate for my docs style.

That said, it has at least one weakness.  If the table of contents (TOC) is too tall, and if you have a short monitor/browser window, some of the TOC scrolls off the bottom.

I do not know how to fix this.   I will re-investigate the other themes to see if I can puzzle this out.

However!  If anyone reading this is a MkDocs expert and has already added scrolling to Cinder, please consider sharing.

Thanks,

Ed

#3

Broken Link

I fixed the broken link.

New Info On Home Page

You will now notice that the home page of the SSK2 docs show both the latest release version and the last time the docs were updated:

( Latest Release:  2017.006)

( Last Docs Update:  15 JAN 2017 @ 1315 PST)

 

Theme + Scrolling Issue

Note: I played around with themes a little, but to no avail.  This is a significant effort for me so it will take some time to fix.  I apologize for the hassle it causes folks till then.

 

 

 

#4

FWIW, I took a quick look and came across a similar mkdocs issue (not cinder theme). You may have seen it already.

Where there were a number of ‘fixes’ mentioned, I didn’t get the impression there is a solid fix. That said, one of the ‘fixes’ might give you a ‘aha’ moment.

https://github.com/mkdocs/mkdocs/issues/204

#5

@Graham07,

Noted.  

Broken Link

I’ll fix that shortly.

Scrolling

This may take a bit longer.

To produce these docs I am using MkDocs  with the ‘Cinder’ theme.

I’ve tried all of the the public themes and this seems to be the most legible and easy to navigate for my docs style.

That said, it has at least one weakness.  If the table of contents (TOC) is too tall, and if you have a short monitor/browser window, some of the TOC scrolls off the bottom.

I do not know how to fix this.   I will re-investigate the other themes to see if I can puzzle this out.

However!  If anyone reading this is a MkDocs expert and has already added scrolling to Cinder, please consider sharing.

Thanks,

Ed

#6

Broken Link

I fixed the broken link.

New Info On Home Page

You will now notice that the home page of the SSK2 docs show both the latest release version and the last time the docs were updated:

( Latest Release:  2017.006)

( Last Docs Update:  15 JAN 2017 @ 1315 PST)

 

Theme + Scrolling Issue

Note: I played around with themes a little, but to no avail.  This is a significant effort for me so it will take some time to fix.  I apologize for the hassle it causes folks till then.

 

 

 

#7

FWIW, I took a quick look and came across a similar mkdocs issue (not cinder theme). You may have seen it already.

Where there were a number of ‘fixes’ mentioned, I didn’t get the impression there is a solid fix. That said, one of the ‘fixes’ might give you a ‘aha’ moment.

https://github.com/mkdocs/mkdocs/issues/204