Skip to content

Add PQS Troubleshoot page and re-sync Configure/Operate to PQS 3.5 - #1395

Merged
Jatinp26 merged 4 commits into
mainfrom
content/pqs-troubleshoot-page
Sep 1, 2026
Merged

Add PQS Troubleshoot page and re-sync Configure/Operate to PQS 3.5#1395
Jatinp26 merged 4 commits into
mainfrom
content/pqs-troubleshoot-page

Conversation

@8bitpal

@8bitpal 8bitpal commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add a new PQS Troubleshoot page (sdks-tools/development-tools/pqs/troubleshoot.mdx), converted from the PQS troubleshoot index and its 750-line runbooks reference, placed in the nav after Optimize.
  • While sourcing that page, found Configure and Operate were pinned to PQS 3.4 even though Configure, Operate, Observe, and Recover all have real content changes in 3.5: a new "Dynamic Daml package reload" behavior, pruning-state SQL queries, a new /readyz health endpoint, and removal of the "Representative package ID support" section. Re-synced both pages to 3.5.
  • Fixed a number of dangling RST cross-references across these pages that had never resolved to real links (leftover from earlier RST→MDX conversion), and added dashboard/trace screenshots that were referenced but never copied into the images directory.

Convert the PQS troubleshoot index and its 750-line runbooks reference
into a new page, placed after Optimize in the nav. While sourcing it
found that Configure and Operate were pinned to PQS 3.4 even though
Configure, Operate, Observe, and Recover all have real content changes
in 3.5 (dynamic Daml package reload, pruning-state queries, a new
/readyz endpoint, removed representative-package-ID section), so those
two pages are re-synced to 3.5 as well. Also fixes several pages worth
of dangling RST cross-references that never resolved to real links,
and adds dashboard/trace screenshots that were referenced but never
copied into the images directory.

Signed-off-by: 8bitpal <elias@zerolimit.es>
@mintlify

mintlify Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cantonfoundation 🟢 Ready View Preview Aug 14, 2026, 12:17 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Configure/Operate were re-synced wholesale to PQS 3.5, silently
dropping the PQS 3.4 behavior that MainNet/TestNet still run.
Diffed the 3.4 and 3.5 sources and added <Tabs> only at the four
points that genuinely differ (pruning-state query, representative
package ID support, /readyz endpoint, dynamic Daml package reload),
leaving the unchanged bulk of the page as a single verbatim block.

Signed-off-by: 8bitpal <elias@zerolimit.es>
The metrics-dashboard section carries panel names and screenshots from an
earlier dashboard revision. Metric names (pipeline_*, watermark_ix) verified
current against scribe 3.5.1 Grafana dashboards; adds a reader-facing note
that panel titles in the shipped dashboard may differ.

Signed-off-by: 8bitpal <elias@zerolimit.es>
@Jatinp26
Jatinp26 merged commit c1fe753 into main Sep 1, 2026
4 checks passed
@Jatinp26
Jatinp26 deleted the content/pqs-troubleshoot-page branch September 1, 2026 09:38
thibault-da pushed a commit that referenced this pull request Sep 2, 2026
…1395)

* Add PQS Troubleshoot page and re-sync Configure/Operate to PQS 3.5

Convert the PQS troubleshoot index and its 750-line runbooks reference
into a new page, placed after Optimize in the nav. While sourcing it
found that Configure and Operate were pinned to PQS 3.4 even though
Configure, Operate, Observe, and Recover all have real content changes
in 3.5 (dynamic Daml package reload, pruning-state queries, a new
/readyz endpoint, removed representative-package-ID section), so those
two pages are re-synced to 3.5 as well. Also fixes several pages worth
of dangling RST cross-references that never resolved to real links,
and adds dashboard/trace screenshots that were referenced but never
copied into the images directory.

Signed-off-by: 8bitpal <elias@zerolimit.es>

* Split PQS 3.4/3.5 divergences into version tabs on Operate

Configure/Operate were re-synced wholesale to PQS 3.5, silently
dropping the PQS 3.4 behavior that MainNet/TestNet still run.
Diffed the 3.4 and 3.5 sources and added <Tabs> only at the four
points that genuinely differ (pruning-state query, representative
package ID support, /readyz endpoint, dynamic Daml package reload),
leaving the unchanged bulk of the page as a single verbatim block.

Signed-off-by: 8bitpal <elias@zerolimit.es>

* Flag stale Grafana panel names on PQS Troubleshoot page

The metrics-dashboard section carries panel names and screenshots from an
earlier dashboard revision. Metric names (pipeline_*, watermark_ix) verified
current against scribe 3.5.1 Grafana dashboards; adds a reader-facing note
that panel titles in the shipped dashboard may differ.

Signed-off-by: 8bitpal <elias@zerolimit.es>

---------

Signed-off-by: 8bitpal <elias@zerolimit.es>
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