[NO JIRA] Document documentation redirect feature

diff --git a/server/sonar-web/src/main/js/app/utils/startReactApp.tsx b/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
index ae74f0c467dcd65368416215ceff50670f147fad..33775f35ef40ebda07d30903145d28555f5e0683 100644 (file)
--- a/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
+++ b/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
@@ -159,6 +159,11 @@ function renderRedirects() {
       {renderRedirect({ from: '/users', to: '/admin/users' })}
       {renderRedirect({ from: '/onboarding', to: '/projects/create' })}
       {renderRedirect({ from: '/markdown/help', to: '/formatting/help' })}
+
+      {/*
+       * This redirect enables analyzers and PDFs to link to the correct version of the
+       * documentation without having to compute the direct links themselves (DRYer).
+       */}
       <Route path="/documentation/*" element={<DocumentationRedirect />} />
     </>
   );