machine icon indicating copy to clipboard operation
machine copied to clipboard

Add Deployed Documentation

Open sonny-mo opened this issue 5 years ago • 4 comments

Hi,

I found the documentation a little difficult to navigate, so I deployed a version that is more easily editable and readable. I'm not sure how helpful it is, but you can check out the docs here.

Hopefully it's useful and that it helps people understand how to use machine better 😸

Please feel free to let me know what you think! And you can make edits to what's already there by dragging the sidebar or clicking edit.

sonny-mo avatar Dec 14 '20 06:12 sonny-mo

Very exciting, sonny-mo! Is there a way to keep the hosted docs at Contour in-synch with changes to files here?

migurski avatar Dec 14 '20 17:12 migurski

Great question! The Reference Docs should periodically update to reflect changes in the codebase.

As to the manually written docs, you would just have to press the Edit button to simply make changes, which is as easy as it gets!

sonny-mo avatar Dec 14 '20 17:12 sonny-mo

How does the update take place, is it automatic? Also, where’s the edit button?

migurski avatar Dec 15 '20 16:12 migurski

@migurski great question! The updates are done automatically and silently. Is there a frequency that you prefer? (end of each day, each week, etc.)

Also, the edit button should appear on the right top corner in a prominent blue button (not shown on mobile).

Example below here: image

sonny-mo avatar Dec 15 '20 16:12 sonny-mo