#11

The Ansible documentation should be reasonably up-to-date - I’ve been trying to keep an eye on it, but I will admit that I am not up-to-date with a version running on my own module, and have lost track of versions. The community has been working on keeping it up-to-date, and I’ve certainly been trying to ensure that anyone adding or changing functionality also adds or changes the documentation in the same ‘pull request’ (request to change a bunch of code).

I’ll also note that the Ansible documentation is One Big Page primarily because that’s how it’s written. The styling of the monome site itself possibly makes the delineations between apps hard to tell, and it just becomes one huge page that’s hard to skim; it might be that doing a page-per-app is more appropriate. That’s a little project, and I’m on vacation for a bit so can’t really kick that off.

But I am going to suggest it here now, and perhaps as an enhancement ticket over at Github.

3 Likes
#12

I just copied and pasted the docs for the different Ansible apps into their own word documents and made PDFs.
That works very well for me. A bit of compartmentalization can clear things up quite a bit.

Still, the Monome docs, even though far better than Mannequins, are not necessarily the most straight-forward manuals out there.
Otoh maybe that encourages some head-wrapping-around which may eventually lead to a better understanding.

#13

In the doc it says „By default Note Sync is on, and Loop Sync is set to Track.“, but it seems that after updating the firmware (and thus resetting all presets) the default state for Loop Sync was „All“.

#14

Yes, I know.

The question is: is that intended new behaviour - the default changed, and it was meant to change, and now the docs should change - or is it an oversight on the part of whoever last touched the firmware? I don’t know the answer.

1 Like
#15

I’m keen on taking this on in the next few weeks – thank you for the bump + excellent foundation.

2 Likes
#16

I think this is an error I made while editing the docs, loop sync has been ALL by default for at least three years. I will do a pass over the docs today to remove duplicate sections and check for correctness, very sorry for the trouble all.

3 Likes
#17

Separate documentation pages for each of the apps would be a huge benefit and much appreciated. I’m struggling to learn Kria. Trying to search for something with browser Find (ctrl-F) often sends me into the docs for other apps which simply leads to more frustration when I’m trying to learn something basic.

3 Likes
#18

That would be extremely helpful!

1 Like
#19

Yeah, or at least links from the top to each section (depending on what the translation from markdown to the monome site will support).

1 Like
#20

separating out the apps into subpages makes a ton of sense.

I am happy to do this today, though I might wait on @csboling to glance the current version as one who is more familiar than myself with the current version :slightly_smiling_face:

7 Likes
#21

Shoot, I made a branch here to split Ansible apps out to their own files before I started reading through, and right after I pushed it I saw the discussion on github. Hope that’s not repeating work you already did @infovore! @tehn is there a build script I could use to confirm that the page cross-reference links work correctly? I don’t need to generate the whole site necessarily but am not sure what software is used to compile the markdown. Pandoc? I’ll give that a whirl here in a sec.

4 Likes
#22

Wow! You guys are incredible. Such fast action. What a great community to be a part of.

2 Likes
#23

it’s Jekyll, but I can check the links after PR. thanks!

1 Like
#24

@csboling just hugely improved the docs!!! :heart:

https://monome.org/docs/modular/ansible/

let us know if any problems are found!

7 Likes
#25

This is awesome!

Thanks so much!

1 Like
#26

THANK YOU, the community!!

3 Likes
#27

It’s the start of work I was going to do. But it needs more than just breaking apart - some of the apps need tables of contents, notably Kria, and the index page is torn between being… back-of-box blurb and documentation all at once. (I find it unclear that the list of “what’s in the box” is also a table of contents, and that USB disk mode comes… before all the documentation).

What I’ll do is rebase off the current upstream and keep going, this is certainly the beginning of what I had in mind, and is an immediate improvement for most users.

However: I’m on vacation for a fortnight. I would like to work on this, though, so maybe there could be some leeway for me to do so?

3 Likes
#28

There really is no hurry for you to work on this, imo.
The Ansible page does provide a ton of information to use Kria, so it’s not like a new user (like me) is left clueless.

Enjoy your vacation!

1 Like
#29

Sure, please do! Now that the apps are split out it hopefully also makes merge conflicts easier to resolve and stuff. I deliberately made only minor edits in this pass so as to turn it around sooner, I agree that the main page is pretty abrupt but I basically just left the existing content there that isn’t specific to any app.

1 Like
#30

Thank you!
This already helps a lot with finding specific information.