Skip to content

Show the root logo in every README, add one contributing guide, and fix the README links - #33

Merged
jwrosewell merged 3 commits into
rcfrom
docs/readme-logo-contributing-links
Nov 11, 2026
Merged

jwrosewell merged 3 commits into
rcfrom
docs/readme-logo-contributing-links

Conversation

@jwrosewell

@jwrosewell jwrosewell commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Problem

The READMEs came in from the separate repositories and still carried what those
repositories had.

  • Logo. The root README showed .github/images/logo.png. Every package
    README showed the 51Degrees wordmark from https://51degrees.com/img/logo.png,
    with campaign parameters on the image URL, and fiftyone.pipeline.did
    showed none.
    51degrees-dotnet#75
    found that nuget.org renders images only from
    an allowed list of hosts
    that 51degrees.com is not on, so the .NET package pages showed no logo at
    all, and .NET, PHP, Go and Rust all moved to the repository's own mark
    served from raw.githubusercontent.com. How npmjs.com renders the old URL
    was not checked for this change, because the reason to move is to show the
    same mark as the other four languages wherever the README is read.
  • Contributing. There was no contributing guide anywhere in the repository.
  • Links. The Developer Documentation link at the top of each package
    README, which a package page shows, went to the main page of that package's
    generated API reference, for example
    https://51degrees.com/ip-intelligence-node/index.html, which has no
    content. The root README's table linked the same kind of page for each of the
    four products. Two READMEs linked a dependencies page that now redirects to
    the documentation home page.

.NET, PHP, Go and Rust have all taken this change, so a reader of a Node
package README met a different mark and an empty documentation page where the
same package in another language showed the repository's mark and the quick
start.

Change

  • .github/images/logo-160.png is a 160 pixel copy of .github/images/logo.png,
    the size the root README shows it at. Every package README, and the two
    run_examples.md files, now shows it as a Markdown image from
    raw.githubusercontent.com, which is the host the other four languages
    moved to.
    fiftyone.pipeline.did, which had no logo, gains it below its title. The
    image URL carries no campaign parameters, because it is not a 51degrees.com
    link.
  • CONTRIBUTING.md at the root links the
    51Degrees contributing guide
    and says it applies to every package in this repository. The wording is the
    same five lines .NET, PHP and Go use.
  • Each package README's Developer Documentation link now goes to the product's
    quick start or concepts page on 51degrees.com rather than to the empty
    reference index, and the root README's table gives both the guide and the
    Node.js API reference for each of the four products.
  • The two links to the dependencies page are removed, because that page
    redirects to the documentation home. The tested versions link beside it
    stays.

Every link keeps the five campaign parameters in the order
scripts/utm-lint.ps1 enforces, with utm_source=npm and utm_medium=package
in a package README, utm_source=github and utm_medium=readme in the root
and folder READMEs and utm_medium=docs in the two run_examples.md files,
and utm_term changed where the destination changed.

The same change in the other languages

Language Pull request
.NET #75
PHP #36
Go #58
Rust #277

The CONTRIBUTING.md here is byte for byte the one
51degrees-dotnet#75
added, and the logo URL has the same shape, pointing at main in this
repository. Java #49 and
Python #46 carry it for
those two languages and are not mine.

Tests

Documentation only. No code changes, so there is no test to fail first and no
red run. This draft's own
utm-link-lint check
passes, which is the check that reads the campaign parameters on every link
this touches.

Full build. Run 43023120786,
on tmp/pr-matrix-33, success. Every one of its seven
Setting 'PullRequestSha' lines reads
6d0fa27df31abe4ac0b09c49babaec9bd4a06ffd, which is this head. Configure
printed "Left out 2 macOS entries". The branch it built from was rc at
8b9fc3d, and rc has moved on since. Nothing rc has taken since touches a
README, and the draft merges into the current rc with no conflict.

macOS was left out of this draft's full build under the 9 November decision.
The rc head is built with macOS before it merges into main.

What remains

The logo URL points at .github/images/logo-160.png on main, and this change
is what adds that file, so the image resolves once the change reaches main.
.NET, PHP and Go all point at main in their own repositories in the same way.
A reader on GitHub sees the image from this branch, and a reader of a published
package sees it from the first release after the merge.

…ix the README links

Twenty READMEs and example guides showed an older 51Degrees wordmark from
51degrees.com rather than the logo the root README shows, and the
fiftyone.pipeline.did package README had none. Each now shows the root logo
as a Markdown image from raw.githubusercontent.com, using
.github/images/logo-160.png, a 160 pixel copy of .github/images/logo.png,
the size the root README shows it at.

The repository had no contributing guide of its own. One CONTRIBUTING.md
at the root now links the 51Degrees contributing guide.

The Developer Documentation link at the top of twenty READMEs and example
guides went to the main page of the product's generated API reference,
which has no content. They now go to the product's documentation, and the
root README's table links both that and the class list of the Node.js API
reference. The dependencies page that the Device Detection and IP
Intelligence READMEs linked is gone. The IP Intelligence README's next
sentence already links the tested versions page, so the sentence is
removed, and the Device Detection README links the tested versions page in
its place. The translation package's link to the on-premise package
resolved nowhere, and now goes to it on GitHub, as npm cannot follow a
relative link.
The documentation links went to section pages of the 51Degrees
documentation, such as _device_detection__index.html, which only list the
pages in the section. They now go to the page in each section that is most
helpful to a developer and the most recently kept up to date. Those are the
Device Detection, IP Intelligence and Reverse Geocoding quick starts, which
show how to choose between the cloud and on-premise and how to start in
each language, and Pipeline Basics for the Pipeline API, which has no quick
start. The campaign tags of each link are unchanged.
@jwrosewell
jwrosewell marked this pull request as ready for review November 11, 2026 13:58
@jwrosewell
jwrosewell merged commit 1d7e024 into rc Nov 11, 2026
2 checks passed
@jwrosewell
jwrosewell deleted the docs/readme-logo-contributing-links branch November 11, 2026 13: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.

1 participant