Remodelling the documentation

[kallewesterling]

Summary

The documentation had unclear ordering and files that were named in ways that didn't optimise the SEO of our documentation. That should be fixed with this (see left image below, compared to the former structure on the right).

Fixes #460
Fixes #463

Describe your changes

• minor edits of language for consistency
• fixing front page (removing the TODO list)
• remodelling the documentation files (moving quite a bit around!)

Checklist before assigning a reviewer (update as needed)

• Self-review code
• Ensure submission passes current tests
• Add tests
• Update relevant docs

Reviewer checklist

Please add anything you want reviewers to specifically focus/comment on.

• Everything looks ok?

[rwood-97]

I built this here to check: https://mapreader.readthedocs.io/en/kallewesterling-issue460/

I realise now my comment re. numbering might not be a problem since the numbers don't show in the docs. Might be useful still to indicate the workflows for classification vs text.

Thank you!

[rwood-97]

Minor comment is potentially to remove the numbering from this or somehow make it clear that you can do:

Classficiation:

• download->load->annotate->classify
• download->load->classify (e.g. with pretrained model)
• the above + post processing
• the above - download

Text spotting:

• download->load->spot-text
• the above - download

[kallewesterling]

right, so you mean that:

• the download step is sort-of optional (as long as you have downloaded the maps already)
• the post-processing step is an optional tag-on?

[rwood-97]

yep and if you are doing text spotting you don't have to do classify too

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.77%. Comparing base (5292dd6) to head (089ce64).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #462   +/-   ##
=======================================
  Coverage   62.77%   62.77%           
=======================================
  Files          41       41           
  Lines        6807     6807           
=======================================
  Hits         4273     4273           
  Misses       2534     2534           

Flag	Coverage Δ
unittests	62.77% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rwood-97]

I had a go at fixing merge conflicts here, mostly around the coding basics docs. Can you double check but then I think we are good to merge?

[kallewesterling]

Sounds good -- let me look at your comment before we do though!

[kmcdono2]

This looks great to me! Prompts me to ask @kallewesterling if we can set up some kind of reminder system to add to the 'project cv' and other elements that require updates.

[kallewesterling]

I think we should just have that as a standing point in our sprint meeting to keep revisiting. I'll add it to my idea board for Thursday meetings