Skip to Main Content
InterSystems Ideas
We love hearing from our users. Tell us what you want to see next and upvote ideas from the community.
* Bugs and troubleshooting should as usual go through InterSystems support.
Status Needs review
Categories Documentation
Created by Alex Woodhead
Created on Sep 25, 2025

Automate broken hyperlink validation in online documentation

Scenario

Reviewing Class documentation for class: Config.Startup

The property: PasswordHash

Documentation Text: "Algorithm: A valid Security.Datatype.PBKDF2Alg value."

This has a broken link:

https://docs.intersystems.com/iris20252/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=%25SYS&CLASSNAME=Security.PBKDF2Alg

Which should be:

https://docs.intersystems.com/iris20252/csp/documatic/%25CSP.Documatic.cls?PAGE=CLASS&LIBRARY=%25SYS&CLASSNAME=Security.Datatype.PBKDF2Alg

Proposal

This kind of broken hyperlink are candidates to "catch and remediate" before product release.

Idea 1: Automate reporting for broken links in class documentation of modified classes at integration submission.

Idea 2: General build reporting identifies broken links in class documentation.

Suggested Impact

Moving into 3rd party LLM based documentation interaction and summarization, it becomes more important for source links to be reliable, to maximize training data availability.

  • ADMIN RESPONSE
    Sep 25, 2025

    Thank you for submitting the idea. The status has been changed to "Needs review".

    Stay tuned!

  • Lexi Hayden
    Nov 5, 2025

    @Guest These links are not created manually. The %CSP.Documatic code generates them, ultimately using the %Dictionary classes to obtain the necessary information. In this case, there seems to be a bug.

    This may affect how you view this project.