Using "cut and paste" friendly commands in documentation (better for developer onboarding)

I think that Plone documentation should keep examples of typed commands as "cut and paste" friendly as possible. I've noted that some Plone documentation already uses this approach and it's a big win for me when I want to follow the docs as I can just cut and paste the commands into the terminal.

Just for the sake of illustrating what I'm talking about:

This snippet is a good example: ( from http://docs.plone.org )

This snippet is a bad example: (from http://buildoutcoredev.readthedocs.org/)

It's a little detail but I think being consistent with this will help developers just a tiny bit and help to improve the onboarding experience of developers.

1 Like

Plone Foundation Code of Conduct