Skip to content
This repository has been archived by the owner on May 5, 2022. It is now read-only.

Add Deployed Documentation #781

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sonny-mo
Copy link

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.

@migurski
Copy link
Member

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

@sonny-mo
Copy link
Author

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!

@migurski
Copy link
Member

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

@sonny-mo
Copy link
Author

@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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants