search

openaddresses / machine

Scripts for running OpenAddresses on a complete data set and publishing the results.
http://results.openaddresses.io/
ISC License
97 stars 36 forks source link

Add Deployed Documentation #781

Open sonny-mo opened 3 years ago

sonny-mo commented 3 years ago

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 commented 3 years ago

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

sonny-mo commented 3 years ago

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 commented 3 years ago

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

sonny-mo commented 3 years ago

@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