Skip to content

Show the root logo in every README, link the main contributing guide, and fix the README links - #49

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

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

Conversation

@jwrosewell

@jwrosewell jwrosewell commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Problem

The READMEs that came in with the separate repositories still carry what those repositories had, as 51degrees-dotnet#75 found for .NET.

  • Logo. The root README shows .github/images/logo.png, the 51D mark beside the Java logo. Six READMEs show an older 51Degrees wordmark from 51degrees.com instead.
  • Contributing. The root CONTRIBUTING.md links the guide in common-ci rather than the 51Degrees contributing guide, which every repository without its own guide shows.
  • Links. The Developer Documentation link at the top of six READMEs goes to the main page of the product's generated API reference, which has no content, for example pipeline-java/index.html. The root README's table, and the pipeline README's sentence about the API reference, link the same kind of page. The Device Detection and IP Intelligence READMEs link a dependencies page that now redirects to the documentation home page. The location README's Maven link goes to search.maven.org, which answers 403.

Change

  • .github/images/logo-160.png is a 160 pixel copy of .github/images/logo.png, the size the root README shows it at. The six READMEs show it as a Markdown image from raw.githubusercontent.com, as the package READMEs in the other repositories do, where package sites need an absolute address.
  • The root CONTRIBUTING.md links the 51Degrees contributing guide, which leads on to the full guide in common-ci. It is the only contributing guide in the repository.
  • Each Developer Documentation link goes to the product's quick start, or to Pipeline Basics for the Pipeline API, which has no quick start. They are the pages of the documentation most helpful to a developer and the most recently kept up to date: Pipeline Basics, Device Detection Quick Start, IP Intelligence Quick Start and Reverse Geocoding Quick Start.
  • Every other link to a section page of the documentation, such as _device_detection__index.html, which only lists the pages in the section, goes to the same pages.
  • The root README's table links each product's guide and the class list of its Java API reference, for example pipeline-java/annotated.html. The pipeline README's sentence about the API reference links that class list.
  • The sentence linking the dependencies page is removed from the Device Detection and IP Intelligence READMEs, as the next sentence in each already links the tested versions page. The documentation repository has no dependencies page to replace the old one.
  • The location README's Maven link goes to the artifact on central.sonatype.com.

The logo is linked from main, so viewing these READMEs on rc shows it missing until rc is released into main.

Not changed

  • The links to the old repositories in the root README's History section, which list them on purpose.
  • The READMEs that have no logo, as none of them is shown on a package site. Maven Central does not show READMEs.
  • The text beside each logo, such as Java Device Detection.

The same change in the other languages

The same change is merged in 51degrees-dotnet#75, 51degrees-php#36, 51degrees-go#58, 51degrees-rust#277 and, today, 51degrees-python#46 and 51degrees-node#33. This draft follows them, showing the root logo at 160 pixels from raw.githubusercontent.com, linking the one 51Degrees contributing guide and sending each documentation link to a page with content. Java is the last repository without it.

Checks

  • Every new target was fetched without its campaign tags, and each answers 200 with content.
  • The common-ci UTM link lint passes on the changed files.
  • Only Markdown files and the image change, so the full build was not needed. James Rosewell decided on 9 November 2026 that pull requests changing only Markdown, an image or package text skip the full build, and merge on "UTM link lint", "Only rc into main" and an independent review.
  • One was run all the same, run 43033269417, and it is green. Every job prints Setting 'PullRequestSha' to '4ef050ef6d70dd6c18ccf5721388c1d933fb930f', ten lines over the ten jobs with no other value, and that is this branch's head. No job ended in anything but success or skipped.
  • 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.
  • There are no tests here to show failing first, because nothing but Markdown and an image changes.

Release note

The READMEs show the 51Degrees logo the repository's README shows, and their documentation links go to pages with content.

The heading beside the logo in location/README.md still says Pipeline API for the geo-location package. The text beside each logo is outside this change and is left as it was.

… and fix the README links

Six READMEs showed an older 51Degrees wordmark from 51degrees.com rather
than the logo the root README shows. 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 root CONTRIBUTING.md linked the guide in common-ci. It now links the
51Degrees contributing guide, which leads on to the full guide in common-ci.

The Developer Documentation link at the top of six READMEs went to the main
page of the product's generated API reference, which has no content. They
now go to the product's documentation. The root README's table links both
that and the class list of the Java API reference, and the pipeline
README's sentence about the API reference links the class list. The
dependencies page that the Device Detection and IP Intelligence READMEs
linked is gone, and the next sentence in each already links the tested
versions page, so the sentence is removed. The location README's Maven link
went to search.maven.org, which answers 403, and now goes to the artifact on
central.sonatype.com.
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 17:24
@jwrosewell
jwrosewell merged commit bf66e3d into rc Nov 11, 2026
2 checks passed
@jwrosewell
jwrosewell deleted the docs/readme-logo-contributing-links branch November 11, 2026 17:24
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