New 0.0.9 documentation in the wiki

[knox-dawson]

The wiki now includes tentative docs for version 0.0.9 (based on 0.0.9-alpha.6). I expect it will change as 0.0.9 is finalized.

The docs for 0.0.8 are still there. Github's lack of support for page hierarchy in the wiki is a bit freaky, so there's a sidebar that will hopefully make it less confusing.

Feedback and correctlions are welcome.

https://github.com/mb1986/rm-hacks/wiki

[mb1986]

I really appreciate all the work you've put and you are putting into this, thank you! :bowing_man:

[knox-dawson]

I really appreciate all the work you've put and you are putting into this, thank you! 🙇‍♂️

Hey, what you do, I can't do. And THAT I appreciate tremendously.

[atngames]

This is super duper helpful

[Tissefantonsen]

Hi, great work!

Could we please have this documentation as part of the hack?

[atngames]

you mean on the tablet?

[Tissefantonsen]

Yes :-)

[knox-dawson]

So I cloned the wiki and ran this command:

pandoc --pdf-engine=xelatex -V geometry:margin=1in -o rm-hacks.pdf rM-Hacks-Documentation-0.0.8.md Settings-Configuration-0.0.8.md Features-Overview-0.0.8.md Gestures-0.0.8.md Strokes-0.0.8.md Bookmarks-0.0.8.md Document-Level-Settings-0.0.8.md

It came out better than I expected.

rm-hacks.pdf

[knox-dawson]

Obsidian does a better job, though I'm still struggling with images being orphaned from their description.

rM-Hacks-Documentation.pdf

[Tissefantonsen]

Thanks! Looks great :-) Could this be added (and kept updated) as "Documentation" here on the config page??

[PepikVaio]

Would be greate.

[dreadful-brain]

Obsidian does a better job, though I'm still struggling with images being orphaned from their description.

rM-Hacks-Documentation.pdf

But unfortunately no TOC-Bookmarks and internal links are not working in this version, the functionality of pandoc was better.

[knox-dawson]

Thanks! Looks great :-) Could this be added (and kept updated) as "Documentation" here on the config page?? !

The docs for 0.0.9 are here https://github.com/mb1986/rm-hacks/wiki/rM-Hacks-Documentation, is that what you mean? (alpha-6 ... alpha-7 soon come)

[Tissefantonsen]

knox-dawson Hi, my thought was to have the documentation included in the "configuration settings" for the hack, below the "stylus configuration"...

[knox-dawson]

This will probably be my last effort for version 0.0.8.

rm-hacks-documentation-toc2.pdf

[knox-dawson]

The wiki is updated for 0.0.9-alpha.7 https://github.com/mb1986/rm-hacks/wiki/rM-Hacks-Documentation

I installed alpha.8, but I'm seeing bugs, so I'm leaving the docs as is for now.

[knox-dawson]

PDF version. The table of contents is way long. Thinking about that. There's a shorter TOC on the last page. I thought that would be the one it would use, but apparently not. It wants to include every heading at every level. Still learning ...

rm-hacks-documentation-0.0.9.pdf

[knox-dawson]

The wiki is updated for 0.0.9-alpha.10 https://github.com/mb1986/rm-hacks/wiki/rM-Hacks-Documentation

[knox-dawson]

The wiki is updated for 0.0.9 roll-out. More deep-dive stuff to come, especially QuickTools.

[Eeems]

I would highly recommend pointing at the existing community documentation for SSH access: https://remarkable.guide/guide/access/ssh.html

[knox-dawson]

I would highly recommend pointing at the existing community documentation for SSH access: https://remarkable.guide/guide/access/ssh.html

I'm thinking you mean in the Installation section? https://github.com/mb1986/rm-hacks/wiki/rM-Hacks-Documentation#installation

Something like this?

[Eeems]

I would highly recommend pointing at the existing community documentation for SSH access: https://remarkable.guide/guide/access/ssh.html

I'm thinking you mean in the Installation section? https://github.com/mb1986/rm-hacks/wiki/rM-Hacks-Documentation#installation

Correct, to that section of the 0.0.9 (and any other) documentation.

Something like this?

That looks good to me

[knox-dawson]

FYI, I added two pages to the docs:

https://github.com/mb1986/rm-hacks/wiki/Toolbar https://github.com/mb1986/rm-hacks/wiki/Installation

The toolbar page has more details about rM Hack's features wrt the toolbar. The installation page simply moves the installation instructions to a separate page.