Skip to Main Content
InterSystems Ideas

Have an idea, suggestion, or something that doesn’t work as expected in InterSystems products or services? Share it here on the InterSystems Ideas Portal.

The Ideas Portal is where community members can propose improvements, report bugs, and help influence the product roadmap across InterSystems products and the overall developer experience. 22% of submitted ideas are implemented by InterSystems or members of the Developer Community.

💡 Ideas and bugs are both welcome, no matter how big or small. You can submit feature requests, usability improvements, workflow suggestions, and bug reports. Whether you’re an experienced expert or just getting started, your fresh perspective is valuable.

🛠️ About bugs and fixes. If you have access to InterSystems WRC, please submit bugs there for immediate action. Bug reports submitted through the Ideas Portal are reviewed and tracked, but do not guarantee immediate resolution.

Start by sharing what could be better - the community and our teams will help take it from there.

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.