Skip to content

docs: fix hosting badges, installation link and brand typos - #496

Merged
deluan merged 7 commits into
masterfrom
docs/hosting-badges-485
Oct 9, 2026
Merged

deluan merged 7 commits into
masterfrom
docs/hosting-badges-485

Conversation

@deluan

@deluan deluan commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Description

The managed-hosting changes in #485 render Zenith at 49px high beside a 40px PikaPods button, and ElfHosted is a plain link. Carry forward that contributor's commits onto current master and render all three providers as matching 200×40px deployment badges.

The SVGs live in static/images/hosting/ and match the README assets. PikaPods and Zenith preserve their original artwork, scaled uniformly on centered, padded canvases with matching brand-color backgrounds. ElfHosted uses its original mascot in a self-contained deployment badge. Logo proportions, provider links and hosting text are retained.

Also fix the broken relative ElfHosted link on the installation page and clear brand-page typos (at the of → at the end of, som → some, explicitely → explicitly, eg. → e.g.). The original brand guidance and hosting claims are otherwise preserved.

Related to #485. Also reviewed #469, which constrains Zenith's height but does not cover ElfHosted or equal-width badges. Existing contributor PRs remain open and untouched.

Type of change

  • Documentation
  • Styling / layout

Checklist

  • Full Hugo 0.166.0 extended build passes in an isolated Docker container
  • Previewed the built page in an isolated real browser at 1280px and 390px, light/dark
  • git diff --check and asset checks pass

Validation

All three badges load and render exactly 200×40px with proportional artwork. Every changed website file matches the source used for the local build and screenshots. SVG path checks confirm original provider artwork is unchanged; assets are self-contained and identical across both repositories. The installation-page link resolves to /docs/installation/managed/#elfhosted.

The full build used no user data or real secrets. Translation statistics were omitted from local validation; unrelated public app-update requests produced expected unauthenticated API warnings.

The [skip ci] commit intentionally prevents Preview Build from triggering automatic Cloudflare deployment, honoring the request to avoid website deployment. CI/deployment checks are therefore skipped. No website was deployed.

Full page screenshots and labeled side-by-side comparisons of real badge crops are saved in Library. Existing mobile page overflow was observed before and after; the three badges fit within the content column.

Summary by CodeRabbit

  • Documentation
    • Clarified branding guidance for independent apps, including permitted references and logo use, restrictions on misleading names and domains, packaging requirements, and how to request permission.
    • Updated managed-hosting information across the FAQ and installation pages, adding ElfHosted and refining Zenith Hosting links and details.
    • Updated hosting listings with deployment links and a local image for PikaPods.

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d437fab7-b086-4f6e-96f8-e61846bcb91c

📥 Commits

Reviewing files that changed from the base of the PR and between 00b6ff7 and 0fd5a4d.


📒 Files selected for processing (2)
  • content/en/brand/_index.md
  • content/en/docs/installation/managed.md

🚧 Files skipped from review as they are similar to previous changes (2)
  • content/en/docs/installation/managed.md
  • content/en/brand/_index.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The brand page updates rules for references to Navidrome, app names, logo use, packaging, and permission requests. The installation and FAQ pages update managed-hosting listings, descriptions, and links.

Changes

Brand guidance

Layer / File(s) Summary
Compatibility and identity rules
content/en/brand/_index.md
The page clarifies permitted references to Navidrome and rules for app names, domains, and social accounts.
Logo, packaging, and permission rules
content/en/brand/_index.md
The page updates logo-use guidance, requests an independence statement from app makers, and revises packaging and permission-request guidance.

Managed hosting listings

Layer / File(s) Summary
Provider listings and links
content/en/docs/installation/_index.md, content/en/docs/installation/managed.md, content/en/docs/faq/_index.md
The pages add ElfHosted, update the Zenith Hosting listing and links, revise the revenue-sharing description, and use a local image for the PikaPods button.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to 0fd5a

The hosting badges and documentation links resolve as intended. No identified issue blocks merging after normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to 00b6f

The change affects 1 system.

Changed systems: content

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — content (service) was modified; 4 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in content/en/brand/_index.md: The introduction now covers building apps, writing about Navidrome or related apps, and showing work; it states that following the guidelines grants permission and gives an updated link. The short version expands allowed references to app store names, in-app connection flows, marketing materials, and Navidrome content, and explicitly prohibits implying official status or project endorsement.
  • observed — Modified behavior in content/en/brand/_index.md: The name guidance adds examples for compatibility claims and clarifies that Subsonic-only support must not imply Navidrome-only features. The app-name examples now distinguish allowed from prohibited names, add more prohibited lookalikes, and allow partial-word names that do not read as “Navidrome.” Domain and social-account rules specify that official-looking identities are prohibited while a subdomain for an owned server is allowed. The logo section heading now follows these rules.
  • observed — Modified behavior in content/en/brand/_index.md: The logo guidance now refers to other server types, explicitly prohibits using the logo within an app icon, and permits logo use in app-related articles, videos, and dashboards. It specifies preserving the logo’s colors and proportions, not adding elements or cropping it, and leaving surrounding space. App makers are now instructed to state explicitly that their project is independent, with a sample disclaimer.
  • observed — Modified behavior in content/en/brand/_index.md: Packaging guidance now allows small patches needed for packaging and asks packagers to link to the official project. The closing guidance adds GitHub discussions as the route for uses not covered by the page and for permission requests.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately summarizes the main changes: documentation updates for hosting badges, installation links, and brand text corrections.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.


✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Preview Deployment

Status URL
✅ Deployed pr-496.navidrome-website.pages.dev

Built from 0fd5a4d

@deluan
deluan marked this pull request as ready for review October 9, 2026 12:18
@strix-security

strix-security Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Strix Security Review

Warning

This pull request has 1 commit after the last Strix review (00b6ff7). Strix has not reviewed these changes.
Automatic review on push is off for this repository. To review the latest changes, tag @strix-security in a comment, or turn on re-review on push.

No security issues found.

Review summary

Reviewed all seven changed files in PR #496: three documentation pages (brand guidelines, FAQ, installation index, and the managed-hosting page) and three new static SVG hosting badges. The changes are documentation and styling only — prose rewrites, markdown link/anchor updates, and self-contained SVG image assets served via <img> tags. The SVGs contain no scripts, event handlers, foreignObject, or external references, and one change actually removes a remote third-party image dependency in favor of a local asset. No executable code, secret material, authentication, authorization, or data-handling changes are present. No security vulnerabilities were identified.

Updated for 00b6ff7.


Reviewed by Strix
Re-run review · Configure security review settings

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 00b6ff7aaa

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

<a href="https://www.pikapods.com/pods?run=navidrome"><img style="height:40px;width:auto" src="/images/hosting/pikapods.svg" alt="Run on PikaPods"></a>

### Zenith
### Zenith Hosting

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Preserve the published Zenith anchor

Renaming this heading changes its generated fragment from #zenith to #zenith-hosting. The previous FAQ and installation pages both published links to /docs/installation/managed/#zenith, so bookmarked or externally copied versions of those URLs will now land at the top of the page instead of the provider section. Keep an explicit zenith anchor (or equivalent compatibility target) while displaying the longer heading.

Useful? React with 👍 / 👎.

Comment thread content/en/brand/_index.md Outdated

Keep it true. If your app only supports the Subsonic API, don't say it supports Navidrome-only
features.
**App and project names.** Your app needs its own name. You can add "Navidrome" at the end of the name to tell people what it works with.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Align the naming rule with the allowed examples

This sentence now says that Navidrome must be at the end of the app name, but the same page explicitly approves MyAmazingApp - Navidrome & Jellyfin, where it is not last. Developers relying on this brand-permission page therefore cannot determine whether multi-service suffixes are permitted; retain the earlier “after your own app name” wording or update the examples to match the stricter rule.

Useful? React with 👍 / 👎.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-09T12:21:07.599921Z 00b6ff7 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@deluan
deluan merged commit 83aa955 into master Oct 9, 2026
2 checks passed
@deluan
deluan deleted the docs/hosting-badges-485 branch October 9, 2026 12:57
@deluan
deluan restored the docs/hosting-badges-485 branch October 9, 2026 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants