Resolve docs release conflicts - #70
Merged
Merged
Conversation
Update endpoints
Fix subfilter example for servarr.
Bump mkdocs-include-markdown-plugin
- Move setup to its own folder - Add catppuccin community theme page - Fix some relative link complaints - Standardize the theme markdown files with jinja include-markdown.
Use addon example template instead.
Add some information on the setup page about the different methods.
Add docs for new favicon addons
…thon-from-4.2.0-to-5.0.0 Bump actions/setup-python from 4.2.0 to 5.0.0
…-from-3-to-4 Bump actions/checkout from 3 to 4
Use file_exists to only render screenshots and logo iif they exist. Add __pycache__ to gitignore.
Add Docmost markdown file and screenshots
…hots-that-exits Add file_exists macro to jinja context.
Add Authelia theme page & authelia addons page.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The review found a critical deployment-permission issue and multiple broken links, generated instructions, and navigation or metadata problems.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (7)
What changed in this PR
This PR resolves documentation merge conflicts by adopting shared MkDocs templates, refreshing addon/theme paths, and updating setup, navigation, and deployment configuration.
Changes:
- Migrates app and addon pages to shared title, installation, addon, and screenshot templates.
- Refreshes navigation, setup links, community themes, assets, and dependencies.
- Updates CI workflows and preserves refreshed application documentation.
| File | Review summary |
|---|---|
README.md |
Moderate (2 votes): Add cd tp-docs after cloning before installing requirements. |
mkdocs.yml |
Moderate (1 vote): Restore /index.md for directory-valued addon entries. Nit (2 votes): Add both Sonarr anime pages to navigation. |
main.py |
Adds the file_exists documentation macro. |
docs/themes/xbackbone.md |
Moderate (1 vote each): Fix both relative site-assets links. |
docs/themes/whisparr.md |
Migrates the Whisparr theme page to shared templates. |
docs/themes/webtools.md |
Migrates the WebTools theme page to shared templates. |
docs/themes/vuetorrent.md |
Migrates the VueTorrent theme page to shared templates. |
docs/themes/uptime-kuma.md |
Migrates the Uptime Kuma theme page to shared templates. |
docs/themes/unraid.md |
Migrates the Unraid theme page to shared templates. |
docs/themes/transmission.md |
Migrates the Transmission theme page to shared templates. |
docs/themes/title.md |
Moderate (1 vote): Strip .md before asset lookup and display-name rendering. |
docs/themes/thelounge.md |
Migrates the The Lounge theme page to shared templates. |
docs/themes/tautulli.md |
Migrates the Tautulli theme page to shared templates. |
docs/themes/synclounge.md |
Migrates the SyncLounge theme page to shared templates. |
docs/themes/sonarr.md |
Migrates the Sonarr theme page to shared templates. |
docs/themes/servarr.md |
Moderate (3 votes): Close the replacement string before terminating the sub_filter directive. |
docs/themes/screenshots.md |
Moderate (1 vote): Use the filename stem when checking and constructing screenshot assets. |
docs/themes/sabnzbd.md |
Migrates the SABnzbd theme page to shared templates. |
docs/themes/rutorrent.md |
Migrates the ruTorrent theme page to shared templates. |
docs/themes/resilio-sync.md |
Migrates the Resilio Sync theme page to shared templates. |
docs/themes/requestrr.md |
Migrates the Requestrr theme page to shared templates. |
docs/themes/readarr.md |
Migrates the Readarr theme page to shared templates. |
docs/themes/radarr.md |
Migrates the Radarr theme page to shared templates. |
docs/themes/qbittorrent.md |
Migrates the qBittorrent theme page to shared templates. |
docs/themes/prowlarr.md |
Migrates the Prowlarr theme page to shared templates. |
docs/themes/portainer.md |
Migrates the Portainer theme page to shared templates. |
docs/themes/plpp.md |
Migrates the PLPP theme page to shared templates. |
docs/themes/plex.md |
Migrates the Plex theme page to shared templates. |
docs/themes/pihole.md |
Migrates the Pi-hole theme page to shared templates. |
docs/themes/petio.md |
Migrates the Petio theme page to shared templates. |
docs/themes/overseerr.md |
Migrates the Overseerr theme page to shared templates. |
docs/themes/organizr.md |
Migrates the Organizr theme page to shared templates. |
docs/themes/ombi.md |
Migrates the Ombi theme page to shared templates. |
docs/themes/nzbhydra2.md |
Migrates the NZBHydra2 theme page to shared templates. |
docs/themes/nzbget.md |
Migrates the NZBGet theme page to shared templates. |
docs/themes/nginx-proxy-manager.md |
Migrates the Nginx Proxy Manager theme page to shared templates. |
docs/themes/netdata.md |
Migrates the Netdata theme page to shared templates. |
docs/themes/mylar3.md |
Migrates the Mylar3 theme page to shared templates. |
docs/themes/moviematch.md |
Migrates the MovieMatch theme page to shared templates. |
docs/themes/monitorr.md |
Migrates the Monitorr theme page to shared templates. |
docs/themes/logarr.md |
Migrates the Logarr theme page to shared templates. |
docs/themes/lldap.md |
Migrates the LLDAP theme page to shared templates. |
docs/themes/lidarr.md |
Migrates the Lidarr theme page to shared templates. |
docs/themes/librespeed.md |
Migrates the LibreSpeed theme page to shared templates. |
docs/themes/lazylibrarian.md |
Migrates the LazyLibrarian theme page to shared templates. |
docs/themes/kitana.md |
Migrates the Kitana theme page to shared templates. |
docs/themes/jellyfin.md |
Migrates the Jellyfin theme page to shared templates. |
docs/themes/jackett.md |
Migrates the Jackett theme page to shared templates. |
docs/themes/installation.md |
Adds the shared installation section. |
docs/themes/guacamole.md |
Migrates the Guacamole theme page to shared templates. |
docs/themes/grafana.md |
Migrates the Grafana theme page to shared templates. |
docs/themes/gitea.md |
Migrates the Gitea theme page to shared templates. |
docs/themes/gaps.md |
Migrates the Gaps theme page to shared templates. |
docs/themes/flood.md |
Migrates the Flood theme page to shared templates. |
docs/themes/filebrowser.md |
Migrates the FileBrowser theme page to shared templates. |
docs/themes/emby.md |
Migrates the Emby theme page to shared templates. |
docs/themes/duplicati.md |
Migrates the Duplicati theme page to shared templates. |
docs/themes/duplicacy.md |
Migrates the Duplicacy theme page to shared templates. |
docs/themes/dozzle.md |
Migrates the Dozzle theme page to shared templates. |
docs/themes/docmost.md |
Migrates the Docmost theme page to shared templates. |
docs/themes/deluge.md |
Migrates the Deluge theme page to shared templates. |
docs/themes/calibreweb.md |
Migrates the Calibre-Web theme page to shared templates. |
docs/themes/bitwarden.md |
Migrates the Bitwarden theme page to shared templates. |
docs/themes/bazarr.md |
Migrates the Bazarr theme page to shared templates. |
docs/themes/authelia.md |
Migrates the Authelia theme page to shared templates. |
docs/themes/audiobookshelf.md |
Migrates the Audiobookshelf theme page to shared templates. |
docs/themes/adguard.md |
Migrates the AdGuard theme page to shared templates. |
docs/themes/addons/whisparr/whisparr-darker/index.md |
Adds the Whisparr darker addon documentation. |
docs/themes/addons/whisparr/whisparr-alt-calendar/index.md |
Adds the Whisparr alternate-calendar addon documentation. |
docs/themes/addons/whisparr/whisparr-4k-logo/index.md |
Adds the Whisparr 4K logo addon documentation. |
docs/themes/addons/whisparr/alt-calendar/index.md |
Adds the alternate-calendar addon documentation. |
docs/themes/addons/sonarr/sonarr-text-logo/index.md |
Adds the Sonarr text-logo addon documentation. |
docs/themes/addons/sonarr/sonarr-darker/index.md |
Adds the Sonarr darker addon documentation. |
docs/themes/addons/sonarr/sonarr-anime-text-logo/index.md |
Nit (3 votes): Rename the heading to the anime text-logo addon. Nit (1 vote): Correct the first four preview alt texts. |
docs/themes/addons/sonarr/sonarr-anime-logo/index.md |
Nit (2 votes): Describe this as an anime logo rather than a text logo. |
docs/themes/addons/sonarr/sonarr-anime-favicon/index.md |
Adds the Sonarr anime favicon addon documentation. |
docs/themes/addons/sonarr/sonarr-anime-blue-favicon/index.md |
Adds the Sonarr anime blue favicon addon documentation. |
docs/themes/addons/sonarr/sonarr-4k-text-logo/index.md |
Adds the Sonarr 4K text-logo addon documentation. |
docs/themes/addons/sonarr/sonarr-4k-logo/v3-desktop.png |
Adds the Sonarr 4K addon preview asset. |
docs/themes/addons/sonarr/sonarr-4k-logo/index.md |
Adds the Sonarr 4K logo addon documentation. |
docs/themes/addons/sonarr/sonarr-4k-favicon/index.md |
Adds the Sonarr 4K favicon addon documentation. |
docs/themes/addons/sonarr/index.md |
Moderate (3 votes): Remove the placeholder setup include or use a real addon name. |
docs/themes/addons/sonarr/4k-logo/index.md |
Adds the Sonarr 4K logo addon documentation. |
docs/themes/addons/readarr/readarr-text-logo/index.md |
Adds the Readarr text-logo addon documentation. |
docs/themes/addons/readarr/readarr-darker/index.md |
Adds the Readarr darker addon documentation. |
docs/themes/addons/readarr/readarr-alt-logo/index.md |
Adds the Readarr alternate-logo addon documentation. |
docs/themes/addons/readarr/readarr-alt-favicon/index.md |
Adds the Readarr alternate-favicon addon documentation. |
docs/themes/addons/readarr/readarr-alt-calendar/index.md |
Adds the Readarr alternate-calendar addon documentation. |
docs/themes/addons/readarr/alt-calendar/index.md |
Adds the alternate-calendar addon documentation. |
docs/themes/addons/radarr/radarr-darker/index.md |
Adds the Radarr darker addon documentation. |
docs/themes/addons/radarr/radarr-anime-logo/index.md |
Adds the Radarr anime-logo addon documentation. |
docs/themes/addons/radarr/radarr-anime-favicon/index.md |
Adds the Radarr anime-favicon addon documentation. |
docs/themes/addons/radarr/radarr-alt-calendar/index.md |
Adds the Radarr alternate-calendar addon documentation. |
docs/themes/addons/radarr/radarr-4k-logo/index.md |
Adds the Radarr 4K logo addon documentation. |
docs/themes/addons/radarr/radarr-4k-favicon/index.md |
Adds the Radarr 4K favicon addon documentation. |
docs/themes/addons/radarr/alt-calendar/index.md |
Adds the alternate-calendar addon documentation. |
docs/themes/addons/radarr/4k-logo/index.md |
Adds the Radarr 4K logo addon documentation. |
docs/themes/addons/prowlarr/prowlarr-text-logo/index.md |
Adds the Prowlarr text-logo addon documentation. |
docs/themes/addons/prowlarr/prowlarr-darker/index.md |
Adds the Prowlarr darker addon documentation. |
docs/themes/addons/plex/plex-alt-logo/index.md |
Adds the Plex alternate-logo addon documentation. |
docs/themes/addons/plex/overseerr-side-menu/index.md |
Adds the Overseerr side-menu addon documentation. |
docs/themes/addons/lidarr/lidarr-darker/index.md |
Adds the Lidarr darker addon documentation. |
docs/themes/addons/lidarr/lidarr-alt-calendar/index.md |
Adds the Lidarr alternate-calendar addon documentation. |
docs/themes/addons/lidarr/alt-calendar/index.md |
Adds the alternate-calendar addon documentation. |
docs/themes/addons/example.md |
Moderate (2 votes): Strip the application prefix from generated Traefik addon values. |
docs/themes/addons/bazarr/bazarr-darker/index.md |
Adds the Bazarr darker addon documentation. |
docs/themes/addons/bazarr/bazarr-4k-logo/index.md |
Adds the Bazarr 4K logo addon documentation. |
docs/themes/addons/bazarr/4k-logo/index.md |
Adds the Bazarr 4K logo addon documentation. |
docs/themes/addons/authelia/authelia-login-logo/index.md |
Moderate (1 vote): Use the full authelia-sonarr-logo addon name in the Traefik example. |
docs/themes/addons/addons.md |
Adds shared addon rendering and setup documentation. |
docs/setup/index.md |
Moderate (1 vote each): Fix the theme-options, community-themes, and Sonarr theme links. |
docs/requirements.txt |
Updates the include-markdown dependency constraint. |
docs/custom/index.md |
Updates custom setup and asset links. |
docs/community-themes/infinity-stone-themes/time.md |
Updates the Time community theme page. |
docs/community-themes/infinity-stone-themes/space.md |
Updates the Space community theme page. |
docs/community-themes/infinity-stone-themes/soul.md |
Updates the Soul community theme page. |
docs/community-themes/infinity-stone-themes/reality.md |
Updates the Reality community theme page. |
docs/community-themes/infinity-stone-themes/power.md |
Updates the Power community theme page. |
docs/community-themes/infinity-stone-themes/mind.md |
Updates the Mind community theme page. |
docs/community-themes/index.md |
Updates community-theme navigation and links. |
docs/community-themes/catppuccin/index.md |
Adds the Catppuccin community theme page. |
.gitignore |
Expands ignored development and cache files. |
.github/workflows/lint.yml |
Updates the checkout action used by linting. |
.github/workflows/deploy.yml |
Critical (3 votes): Restrict deployment permissions to contents: write. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -1,5 +1,5 @@ | |||
| name: Deploy docs to GitHub Pages via mkdocs | |||
|
|
|||
| permissions: write-all | |||
|
|
||
| ```bash | ||
| git clone https://github.com/themepark-dev/tp-docs.git | ||
| python3 -m venv venv |
|
|
||
|
|
||
| {% set addon_app = "sonarr" %} | ||
| {% set addon_name = "sonarr-addon-example" %} |
| sub_filter | ||
| '</body>' | ||
| '<link rel="stylesheet" type="text/css" href="https://theme-park.dev/css/base/<app>/<theme>.css"></body> | ||
| '<link rel="stylesheet" type="text/css" href="https://theme-park.dev/css/base/<app>/<theme>.css"></body>; |
| @@ -0,0 +1,28 @@ | |||
| # Sonarr Anime logo | |||
|
|
|||
| Add a text logo to your Sonarr css. | |||
| @@ -0,0 +1,26 @@ | |||
| # Sonarr 4K text logo | |||
Comment on lines
+133
to
+136
| Sonarr Text Logo: themes/addons/sonarr/sonarr-text-logo | ||
| Sonarr 4K Favicon: themes/addons/sonarr/sonarr-4k-favicon | ||
| Sonarr Anime Favicon: themes/addons/sonarr/sonarr-anime-favicon | ||
| Sonarr Anime Blue Favicon: themes/addons/sonarr/sonarr-anime-blue-favicon |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolve the conflicts blocking #69 by bringing main's shared templates and current addon paths into develop. Preserve the refreshed Dozzle, Jellyfin and NPM docs and galleries, plus the Whisparr 4K addon.
MkDocs build passed. All 11 screenshots render for each refreshed app. Merge this into develop before merging #69.
Use Create a merge commit for this PR. Squashing or rebasing would discard the merge ancestry needed to resolve #69.