[Documentation] </> View Source Links Do Not Direct to the Main Branch

[yanli-dev]

Description:

The </> View Source links on the documentation pages do not direct to the main branch but instead open a specific commit or branch. For example, on the page MeasurementType, the </> link:
View Source
opens the 671b91c commit instead of the main branch. This inconsistency may cause confusion, especially if users are expecting the latest code.
This issue appears to impact all pages in the documentation.

Steps to Reproduce:

Navigate to MeasurementType.
Click on the </> View Source link.
Observe that the link points to a specific commit (671b91c) rather than the main branch.
Expected Behavior:
The </> View Source links should direct users to the file in the main branch, ensuring they view the latest code.

Actual Behavior:

The links point to a specific commit or branch, which may not reflect the latest code.

Impact:

This could lead to confusion if users assume the referenced code is up-to-date but instead view an older version tied to a specific commit. It also complicates navigation for those seeking the latest source code.

[Mattjet27]

Hello @yanli-dev, thank you for posting this issue. The team has looked into this and identified both the root cause and a means to address this.

Root Cause: the current behavior of directing the user to the commit rather than the code in the main branch is due how API reference for the GitHub Pages site gets generated. Today, this is part of a two-step process, where the second part of the process generates metadata from pre-compiled code using a separate branch. This process will need to be changed to address this issue.

We are planning to update the process to be a single step based solely on the main branch. The team will post back once we have successfully updated this process to provide the desired behavior.