sssom-py icon indicating copy to clipboard operation
sssom-py copied to clipboard

Improve sssom-py documentation

Open cmungall opened this issue 2 years ago • 1 comments

  • https://mapping-commons.github.io/sssom-py/installation.html
    • [ ] end-users should not have to install from git. use pypi
    • [ ] change cmungall to mapping-commons
    • [ ] consider consolidating docs aimed at developers in one place. keep the main docs aimed at the end-user
  • ordering of pages
    • consult some of our other documentation sites for a better flow here (boomer, linkml, robot, ...)
    • [ ] the first page should be a general intro page, not a confusing index labeled SSSOM-PY in shouty caps :-)
    • [ ] put a link to (a) the general SSSOM docs (b) the paper in the intro
    • [ ] don't label pages generically like "Documentation" (https://mapping-commons.github.io/sssom-py/documentation.html). It's all documentation! This should be "python API documentation" or similar
    • [ ] https://mapping-commons.github.io/sssom-py/examples.html -- this needs filled out
  • https://mapping-commons.github.io/sssom-py/cli_usage.html
    • [ ] remove the pointless extra header level
    • [ ] the CLI guide is fantastic, this is what most people use, put this BEFORE python API docs, which most won't use
    • [ ] is it sssom or sssom-py? the guide is inconsistent
    • [ ] link to boomer docs here https://mapping-commons.github.io/sssom-py/cli_usage.html?highlight=merge#sssom-py-ptable
    • [ ] is the warning here true? https://mapping-commons.github.io/sssom-py/cli_usage.html?highlight=merge#sssom-py-convert if so make issues
    • [ ] in general the docstrings for each of these commands could do with giving a bit more context
    • [ ] what is the difference between parse and convert?
    • [ ] https://mapping-commons.github.io/sssom-py/cli_usage.html?highlight=merge#sssom-py-sparql - give an example
  • https://mapping-commons.github.io/sssom-py/sphinx_documentation.html
    • [ ] this isn't of interest to a general user. consider folding into a more general developer docs page where we also talk about style guide black etc and CONTRIBUTING.md
    • [ ] fix formatting errors e.g. ::
  • Other
    • [ ] remove the "Edit on github" button, it 404s
    • [ ] is it really necessary to have the tests here https://mapping-commons.github.io/sssom-py/documentation.html

general comments: put yourself in the mindset of a naive user and try and write docs that help them. think of times when you have had to install and run a package in a project you are not associated with, what helped you, what didn't

cmungall avatar Mar 18 '22 17:03 cmungall