Skip to content

Add FAQ for attestation visibility before period starts & clarify callout#1277

Merged
nrichers merged 2 commits intomainfrom
nrichers/sc-15720/docs-faq-for-attestation-periods
Apr 10, 2026
Merged

Add FAQ for attestation visibility before period starts & clarify callout#1277
nrichers merged 2 commits intomainfrom
nrichers/sc-15720/docs-faq-for-attestation-periods

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Apr 10, 2026

Pull Request Description

What and why?

Addresses customer confusion where attestations are configured in Settings but nothing appears under Attestations until the scheduled period is active — expected behavior, not a bug.

Changes:

Shortcut: sc-15720

How to test

Capto_ 2026-04-10_11-53-27_am2 Capto_ 2026-04-10_11-59-10_am

What needs special review?

Optional: tone and placement under Workflows FAQ vs. another topic.

Dependencies, breaking changes, and deployment notes

None. Docs-only.

Release notes

internal — no user-facing release note required.

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added the internal Not to be externalized in the release notes label Apr 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This PR introduces documentation enhancements for attestation processes in the project. The changes include:

  • A new FAQ file (_faq-attestations.qmd) that explains the behavior of the Attestations area, particularly highlighting that only active or past periods are displayed, and future-dated periods will not appear until they become active.
  • Updates to the FAQ page about workflows (faq-workflows.qmd) to add a section for attestation-related queries. This update also includes an improved order of categories and integration of the new attestation FAQ via an include directive.
  • Refinements in the guide (working-with-attestations.qmd) to clarify the conditions under which the Attestations sidebar item is visible. The explanation now clearly states that if only future-dated attestation periods exist, the area will remain empty until the first period becomes active.

Overall, the PR improves user guidance by detailing expected behavior and directs users to additional instructions and management pages through updated links and notes.

Test Suggestions

  • Verify that the new FAQ page for attestations (_faq-attestations.qmd) renders correctly and displays the expected content.
  • Ensure that the include directive for the attestation FAQ in the workflows FAQ page (faq-workflows.qmd) properly integrates and displays the new content.
  • Test navigation links to the attestation templates and period management pages to confirm that they point to the correct, active content.
  • Check the sidebar behavior in the attestation guide to confirm that it only appears under the conditions described (active or past periods).

@nrichers nrichers requested a review from emmavdh April 10, 2026 19:01
@nrichers nrichers changed the title docs(faq): Attestation visibility before period starts (sc-15720) Add FAQ for attestation visibility before period starts & clarify callout Apr 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions
Copy link
Copy Markdown
Contributor

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: ec35206

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.68 1.00 0.82
/get-started/get-started.html 0.85 0.74 1.00 0.73
/guide/guides.html 0.85 0.69 1.00 0.82
/index.html 0.93 0.67 1.00 0.82
/releases/all-releases.html 0.86 0.72 1.00 0.73
/support/support.html 0.91 0.69 1.00 0.82
/training/training.html 0.85 0.64 0.96 0.73

@nrichers nrichers merged commit 9d3e585 into main Apr 10, 2026
12 checks passed
@nrichers nrichers deleted the nrichers/sc-15720/docs-faq-for-attestation-periods branch April 10, 2026 21:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants