Improved documentation #461

orangejulius · 2019-08-19T20:52:16Z

Some of the WOF documentation had grown a little stale.

This PR makes the following changes:

move configuration options from a table with poor default formatting to individual sections, allowing for much better descriptions
Correctly describe the importPlace flag's behavior. It has supported multiple values since extract regional data from wof sqlite db #324 but the documentation was not updated
Reorder the readme to include a Quickstart section near the top, with less frequently needed sections (such as the full list of placetypes) moved lower
Improve the documentation of the behavior of the downloader when WOF data has not been updated

This layout is much more readable and allows for additional explanation.

It doesn't need to be so high in the readme.

orangejulius added 4 commits August 19, 2019 16:39

feat(docs): Move table of params to sections

6fad241

This layout is much more readable and allows for additional explanation.

Clarify download script behavior

4a031a6

feat(docs): Move types list to the end

47726a6

It doesn't need to be so high in the readme.

Move quickstart usage to the top of the readme

2a11932

orangejulius added the documentation label Aug 19, 2019

orangejulius merged commit 4e67e68 into master Aug 19, 2019

orangejulius deleted the improved-documentation branch August 19, 2019 20:54

Provide feedback