search

esmero / archipelago-aws-demo

Archipelago deployment using Docker
6 stars 1 forks source link

documentation formatting breaks copy/paste #10

Open t4k opened 5 years ago

t4k commented 5 years ago

Some of the markdown(?) encoding for the documentation is breaking the way code is displayed and inhibits the ability to copy and paste the correct commands. See the code block at http://archipelago.nyc/documentation#step_5_ingest_some_metadata_displays_to_make_playing_much_more_interactive for how the underscores in the code become <em> tags.

DiegoPino commented 5 years ago

Hi Tommy. Thanks for reporting, we will check that and fix. I personally would prefer to keep docs in Github at all, there are just too many ways of getting it wrong on that side! Will fix before friday, beta release is close and we have our hands full but your report forces me to get things done faster on the docs side too. Thanks so much. Ping @natehill in case you can deal with docs sooner.

natehill commented 5 years ago

I'll take a look. Agreed, re: documentation living on github. Keeping it up to date in multiple places certainly seems likely to fail.