Product Guide

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started
Ask A Question

Questions

2
ANSWERED

Github Import Creates Duplicate, Unremovable Pages

With each github import it appears to create a new set of duplicate pages. These duplicate pages lose all of the hand-entered header sections of the originals. This has been an issue for a while, but now we also are also unable to remove either the old or the new duplicate pages, making our documentation page look very unprofessional (docs.hint.com). This is an extremely high priority issue for us. A temporary fix would be to allow us to delete either the original or duplicate pages, but a better fix would be to not duplicate pages when importing from github. Ideally, when we import from github, the github content would overwrite the originally imported github content, but leave any custom text we've added through the readme website. You can tell the newer/duplicate pages because they have a `-1` suffix on their slug. Interestingly, how the duplicated pages are grouped into sections is inconsistent between the two "versions" we have running. (these versions were created for testing purposes and should be effectively identical). Version 1.0 shows two of each group/section, the first section having the original pages and the second section having all of the newer / duplicated pages. See https://docs.hint.com/docs/list-all-patients vs https://docs.hint.com/docs/list-all-patients-1 Version 1.1 did *not* duplicate the header sections, but instead simply groups all of the pages together, half of which are the originals and half of which are the newer imported duplicates. See https://docs.hint.com/v1.1/docs/list-all-patients vs https://docs.hint.com/v1.1/docs/list-all-patients-1 There's also a potentially related issue with the API Explorer for newly imported github pages, see: https://readme.readme.io/discuss/581bb1300726db2300e6732c Please let us know if there's anything we can do to fix this. We do not change our documentation often, so even if there's just a one-time fix we can employ to not have confusing duplicate pages on our API documentation site until the issue is fixed for future imports, that would be great.

Posted by Graham Melcher 3 years ago

0

New Github Imports Breaking API Explorer

For all of our github-synced pages, any newly imported pages don't are not interpolating the `:id` fields. Instead of the URL, it puts the ID in the request body, which breaks any API that depends on the correct request URL. Working Example (previous github import): https://docs.hint.com/v1.1/docs/show-patient See how showing a patient works. Broken: https://docs.hint.com/v1.1/docs/show-patient-1 See how showing a patient errors, saying unable to find patient with id of `:id`. Copy of the error text (since i cannot add an image/screenshot). Note that the URL is incorrect: { "status": 404, "message": "Couldn't find Patient with :id" } Method GET Request Headers Accept: */* Authorization: Basic M2xqbFFhNlZlRzBpQjlXZ3JneXdiZ0MxR3dQVWZNM1dNenc6 accept-encoding: gzip, deflate URL https://api.staging.hint.com/api/provider/patients/:id Request Data { "id": "asdfsadf" } Status 404 Not Found Response Headers server: nginx date: Thu, 03 Nov 2016 21:43:27 GMT content-type: application/json; charset=utf-8 transfer-encoding: chunked connection: close vary: Accept-Encoding x-frame-options: SAMEORIGIN x-xss-protection: 1; mode=block x-content-type-options: nosniff last-modified: Thu, 03 Nov 2016 21:43:27 GMT cache-control: max-age=0, private, must-revalidate set-cookie: XSRF-TOKEN=yiBrBtwozFud783wzvSN5LxGyNX0w8Ez8Dt06iq%2BzcEl7muWzQ9paTkED3PHDvM%2FfKH%2Bt97PQWAHfJaPTZVXng%3D%3D; path=/; expires=Thu, 03 Nov 2016 22:43:27 -0000; secure x-request-id: 49d45fd2-6477-4023-992a-d641aaebf220 x-runtime: 0.027341 strict-transport-security: max-age=31536000 content-encoding: gzip

Posted by Graham Melcher 3 years ago