Skip to content

fix(docs): repair broken internal links - #239

Open
kthoms wants to merge 2 commits into
mainfrom
fix/broken-internal-links
Open

kthoms wants to merge 2 commits into
mainfrom
fix/broken-internal-links

Conversation

@kthoms

@kthoms kthoms commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Fixes internal links reported in #211, #212, #213 that have an unambiguous fix.

Changes

  • user-guide/process-engine/process-diagram-api.md: REST API link pointed to non-existent ../getProcessDefinitionBpmn20XmlByKey. Now uses <RestRef> to operation getProcessDefinitionBpmn20XmlByKey (verified in the OpenAPI spec). (Broken links: Docs, internal: not found (404/410) #213)
  • reference/deployment-descriptors/tags/process-engine.mdx: add id="enableXxeProcessing", linked from security.md. (Broken links: Docs, internal: missing anchor #212)
  • user-guide/spring-boot-integration/process-applications.md: #operaton-bpm-application does not exist; link #operaton-engine-properties, the property list. (Broken links: Docs, internal: missing anchor #212)
  • reference/rest/overview/index.md: raw HTML <a href="authentication.md"> is not rewritten by Docusaurus and 404s; use site path.

Verified with .devenv/scripts/check-links.py check --serve --scope internal: all four no longer reported.

Not fixed here (need an editorial decision)

  • webapps/cockpit/bpmn/process-definition-view.md: links to process-history-views.md, a Camunda Enterprise feature page that does not exist.
  • reference/bpmn20/tasks/script-task.md: third-party-libraries/#process-engine section no longer exists.
  • reference/dmn/decision-table/index.md: ./img/map.js legacy Hugo script is not served.
  • user-guide/process-engine/decisions/bpmn-cmmn.md: FunctionMapper Javadoc link; class is not in published Javadoc.

REST API links (#219, #220) come from the OpenAPI spec in operaton/operaton and must be fixed there.

🤖 Generated with Claude Code

- process-diagram-api: link REST API via RestRef to
  getProcessDefinitionBpmn20XmlByKey instead of a non-existent page
- process-engine.mdx: add enableXxeProcessing anchor referenced from
  security.md
- process-applications: point to existing #operaton-engine-properties
  section instead of missing #operaton-bpm-application
- rest/overview: raw HTML link to authentication.md is not rewritten
  by Docusaurus; use site path instead

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 12, 2026 14:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

- process-definition-view: remove the History View filter section and
  the reference to process history views. Operaton Cockpit has no
  history views (they were a Camunda Enterprise feature). Delete the
  now unused screenshots.
- script-task: link supported script languages to the Scripting
  section instead of a non-existent third-party libraries section
- decision-table: remove the legacy Hugo image map script, which was
  never served and would not run in Docusaurus
- bpmn-cmmn: document custom JUEL functions via
  ExpressionManager#addFunction(String, Method); addFunctionMapper and
  the linked FunctionMapper javadoc no longer exist

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants