Skip to content
This repository has been archived by the owner on Mar 9, 2021. It is now read-only.

documentation formatting breaks copy/paste #10

Open
t4k opened this issue Jul 24, 2019 · 2 comments
Open

documentation formatting breaks copy/paste #10

t4k opened this issue Jul 24, 2019 · 2 comments
Assignees
Labels
Documentation Help make this easier for people to use

Comments

@t4k
Copy link

t4k commented Jul 24, 2019

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
Copy link
Member

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.

@DiegoPino DiegoPino self-assigned this Jul 24, 2019
@DiegoPino DiegoPino added the Documentation Help make this easier for people to use label Jul 24, 2019
@natehill
Copy link

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Help make this easier for people to use
Projects
None yet
Development

No branches or pull requests

3 participants