Repository navigation
docs: fix broken links, stale content and housekeeping - #11839
Open
pranesh-sridhar wants to merge 1 commit into
Open
pranesh-sridhar wants to merge 1 commit into
pranesh-sridhar wants to merge 1 commit into
Conversation
- fix broken internal links (Getting-started, Database-connectors, Calling-other-APIs-and-Web-Services, apidocs, migration pages) - add missing front matter to MONOREPO.md and to its generator script - rename "Create-your-first-app copy.md" to Create-your-first-app.md - move shelved pages from docs/site to docs/spikes/shelved - replace unavailable bluemix SOAP endpoint and strongloop apidocs links - resolve TBD entries in Model and Understanding-the-differences pages - use https for loopback.io, expressjs.com, passportjs.org, graphql.org and sailsjs.com links Signed-off-by: Pranesh Sridhar <Pranesh.Sridhar@ibm.com>
pranesh-sridhar
requested review from
marioestradarosa,
nabdelgadir and
raymondfeng
as code owners
October 16, 2026 12:47
This branch has not been deployed
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.
Summary
Documentation cleanup in
docs/and one small change to a generator script. No runtime code changes.Broken links
Getting-started.md(no such page) now points toInstallation.mdinExamples,Tutorials, the connector tutorials, the SOAP tutorial andmigration/mounting-lb3app.Calling-other-APIs-and-Web-Services.mdnow points toAccessing-services.md, which is the target the published site redirects to.Database-connectors.mdnow points toDatabase-connectors.html, a sidebar-only page../apidocs/*.mdlinks now use the publishedapidocs.<pkg>.<symbol>.htmlform. I checked these against loopback.io.extensions.mdanddocs/site/...links..mdlinks underdocs/site. Therepository.defaultcrudrepository*API pages return 404 on loopback.io today. They are generated bynpm run tsdocs, so I kept them in the same form as the other API links.Housekeeping
Create-your-first-app copy.mdtoCreate-your-first-app.md. Thepermalinkis unchanged, so the published URL stays the same.MONOREPO.mdhad no front matter. I added it, and updatedbin/update-monorepo-file.jsso regeneration keeps it. I didn't run the script because dependencies aren't installed here, so I added the same header by hand.*.shelved.mdpages fromdocs/sitetodocs/spikes/shelved.Stale content
calculator-webservice.mybluemix.net) is down. This is also noted in FIXMEs inexamples/soap-calculator. The tutorial now has a warning, and the generic page uses a placeholder URL. I didn't change the example project.apidocs.strongloop.comlinks.(TBD)entries inModel.md,Understanding-the-differences.mdandREST-action-sequence.md. Where a feature doesn't exist I wrote "Not available yet" rather than inventing content. Please review the wording.http://tohttps://for loopback.io, expressjs.com, passportjs.org, graphql.org and sailsjs.com. I confirmed all five serve HTTPS.Not done
Binding.md,Controller.md,Model.mdand others) are unchanged. They still resolve.bluemix.net. They need a separate rewrite.TODO/FIXMEblocks are left as they are.Checklist
npm testpasses on your machine (docs only, not run)packages/cliwere updated (n/a)examples/*were updated (n/a)