vrr/multi-scrobbler
2
0
Fork 0
mirror of https://github.com/FoxxMD/multi-scrobbler.git synced 2026-04-30 21:00:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Lean 100% into docusaurus documentation

Browse source 
Since docs are now generated alongside builds and hosted on the app server there is no longer a barrier to using docusaurus docs as the main documentation presentation. Any user looking for docs can use the GH Pages hosted site or a "versioned" docs site hosted on their MS app. Due to this we can fully commit to docusaurus and take advantage of MDX layouts to simplify docs.

* Replace env/file configs headings in configuration with MDX tabs to make reading easier
* Remove superfluous TOCs
* Replace internal links in repo readme with links to docsite
This commit is contained in:
FoxxMD 2024-07-16 14:09:28 -04:00
parent ab54422acf
commit ee399136a9
9 changed files with 1249 additions and 1233 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docsite/docs/development/dev-common.md
View file

@ -8,26 +8,6 @@ description: Start here for MS development
# Development
<details>
<summary>Table of Contents</summary>
<!-- TOC -->
* [Architecture](#architecture)
* [Project Setup](#project-setup)
* [Common Development](#common-development)
* [Config](#config)
* [Concrete Class](#concrete-class)
* [Stages](#stages)
* [Stage: Build Data](#stage-build-data)
* [Stage: Check Connection](#stage-check-connection)
* [Stage: Test Auth](#stage-test-auth)
* [Play Object](#play-object)
* [Creating Clients and Sources](#creating-clients-and-sources)
<!-- TOC -->
</details>
## Architecture
Multi-scrobbler is written entirely in [Typescript](https://www.typescriptlang.org/). It consists of a backend and frontend. The backend handles all Source/Client logic, mounts web server endpoints that listen for Auth callbacks and Source ingress using [expressjs](https://expressjs.com/), and serves the frontend. The frontend is a standalone [Vitejs](https://vitejs.dev/) app that communicates via API to the backend in order to render the dashboard.