Skip to content

Update/cleanup documentation

Dan Guest requested to merge dguest/training-dataset-dumper:docs-cleanup into r22

This closes #26 (closed), by better explaining which base project you should use for various purposes. I also took the opportunity to clean up the docs a bit in a few more ways:

  • Made the README a bit more clear
    • I don't instinctively click on a shield, so I added a link to the documentation
    • Hid the Easter egg a bit more carefully, before it was the first link that said "documentation".. I get the joke, I don't like to read, but seeing it for a 5th time doesn't make me like reading any more.
    • Deleted the sections that all just linked to the software docs.
  • Fixed a bug where the "edit" links on the docs pages were giving a 404.
  • Add more links to mattermost and AtlasTalk in the introduction.
  • Renamed index.md -> introduction.md, usage.md -> basic_usage.md, athena.md -> advanced_usage.md
  • Add a section in development on how to check out Athena packages and edit them.
  • Deleted the miscellaneous.md section. Who is going to read that anyway? I moved the only content there into the installation: people should check to check the output from tests as a starting point.
Edited by Dan Guest

Merge request reports