Convert doc pages to mkdocs

[fyliu]

Dependency

• 300

Fixes #167

What changes did you make?

• use mkdocs formatting where the plain text can be converted (tabs, callouts, dropdown content, etc.)

  • some secondary content are put into dropdowns to simplify the main content of the page
  • some titles are shortened to simplify the page content display on the right. Section titles should not be full sentences anyway.

• fix internal links

• fix md formatting like numbered list

• document common mkdocs formatting syntax

Why did you make the changes (we will use this info to test)?

• these are the bulk of the remaining issues to fully convert the documentation from plain markdown to mkdocs which helps certain part more clear and stand out better

Screenshots of Proposed Changes Of The Website (if any, please do not screen shot code changes)

Visuals before changes are applied

contributing page


add new models and API endpoints page


Visuals after changes are applied

contributing page


add new models and API endpoints page


add new models and API endpoints page expanded


[fyliu]

I added syntax examples to the documentation for mkdocs and the description for this PR. This is now ready for review.

[fyliu]

@freaky4wrld Thank you so much for catching this duplication. It looks like the page is duplicated even though the page contents on the right doesn't show it.

I guess the duplication has been there for a couple months already. I used git blame to see when it last changed.

❯ git blame CONTRIBUTING.md -L 433,435
2 months ago    Ethan-Stroming  ec465270│ 433│                                                                        
                                        │ 434│ # Contributing                                                         
                                        │ 435│                                                                        

I'll make a ER to resolve any differences within that file before applying the changes from this PR. #299