update-documentation

[ymahlich]

This is an update to the documentation.
It contains updates to:

• usage.md
• README.md

[ymahlich]

currently it only covers usage.md
We also need to take a look at the style.css, since it seems to be incompatible with the markdown engine jekyll / github recommends and the rendering of the codeblocks is off

[jjacobson95]

I'd recommend saving some time and using the previously defined work-around way that the code blocks were previously displayed (below) as jekyll really struggles with the built-in code block methods. But if you've already made progress getting jekyll to work with the standard code blocks, great!

work-around example:

<div class="code-box">
    <p>import coderdata as cd</p>
    <p><span class="code-comment"># Download a specific dataset</span></p>
    <p>cd.download_data_by_prefix('beataml')</p>
    <p><span class="code-comment"># Download all datasets</span></p>
    <p>cd.download_data_by_prefix()</p>
</div>

[ymahlich]

I am assuming that this is a "problem" of the styles.css, but I am not a webdev so I am unsure. What I can tell you is that the git-hub action to build the docs from this branch fails because the changes can't be deployed due to the repo settings. I am able to download the build artifacts though that contain the build html sites. Opening those build sites locally I can tell that the markdown renderer engine recognizes the codeblocks correctly (I think) but the styling creates some wonky results (see attached screen shot)

[jjacobson95]

This branch now has write permissions to the docs. The most recent one has been re-run and pushed so you can see changes there directly

[jjacobson95]

Feel free to update on the css but I remember there being some previous challenges in modifying the code block style hence the workaround.