Fixed the PR_review issue #755

LoiAnsah · 2025-06-16T18:18:19Z

Related story: https://app.shortcut.com/validmind/story/10755/remove-pr-previews-from-sitemap-urls

Internal Notes for Reviewers

Removed the pr_preview and git branch name from the links on the sitemap.

Old:

Now:

How to test

Grab this PR: gh pr checkout 755
Make sure you're in the site directory if you're not already: cd site
Run make generate-sitemap. This will update the links in the sitemap (/site/_site/sitemap.html)

github-actions · 2025-06-16T18:19:10Z

PR Summary

This pull request updates the URLs used in the sitemap generation process within the Makefile of the site. The changes involve replacing the previous staging or demo domain (https://docs-demo.vm.validmind.ai/pr_previews/$(GIT_BRANCH)/) with the production domain (https://docs.validmind.ai/). This affects the URLs generated in both the sitemap.xml and sitemap.html files, ensuring that the links point to the correct production environment.

The changes are made in the generate-sitemap target of the Makefile, which is responsible for creating the sitemap files. This update is crucial for ensuring that the sitemap reflects the correct URLs for search engine indexing and user navigation.

Test Suggestions

Verify that the sitemap.xml file is generated with the correct production URLs.
Check that the sitemap.html file contains the updated production URLs.
Ensure that the sitemap generation process completes without errors.
Test the accessibility of the generated URLs to confirm they resolve correctly in the production environment.

github-actions · 2025-06-17T00:25:22Z

Vale source linter

⚠️ WARN: Found 13139 issues across 604 files — Check the workflow run or download the full report

Show first 30 files with issues

site/404.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 3: Did you really mean 'html'? (error)
Line 53: Did you really mean 'const'? (error)
Line 53: Use parentheses judiciously. (suggestion)
Line 54: Did you really mean 'const'? (error)
Line 54: Did you really mean 'ctx'? (error)
Line 54: Use parentheses judiciously. (suggestion)
Line 54: Put a nonbreaking space between the number and the unit in '2d'. (error)
Line 58: Did you really mean 'const'? (error)
Line 58: Did you really mean 'fontSize'? (error)
... and 23 more issues

site/about/contributing/style-guide/conventions.qmd

Line 6: Use 'it's' instead of 'it is'. (suggestion)
Line 6: In general, use active voice instead of passive voice ('is received'). (suggestion)
Line 6: Use parentheses judiciously. (suggestion)
Line 9: Use 'capability' or 'feature' instead of 'functionality'. (warning)
Line 9: Use 'shouldn't' instead of 'should not'. (suggestion)
Line 9: In general, use active voice instead of passive voice ('be lost'). (suggestion)
Line 15: Did you really mean 'Palo'? (error)
Line 19: Avoid using 'will'. (warning)
Line 19: In general, use American spelling instead of 'centre'. (warning)
Line 19: Avoid using 'will'. (warning)
... and 182 more issues

site/about/contributing/style-guide/style-guide.qmd

Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Try to avoid using first-person plural like 'We'. (warning)
Line 24: Try to avoid using first-person plural like 'Our'. (warning)
Line 24: Try to avoid using first-person plural like 'our'. (warning)
... and 13 more issues

site/about/contributing/style-guide/voice-and-tone.qmd

Line 6: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'our'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 18: Avoid using 'will'. (warning)
Line 18: In general, use active voice instead of passive voice ('be reviewed'). (suggestion)
Line 22: Use parentheses judiciously. (suggestion)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Don't put a space before or after a dash. (error)
... and 39 more issues

site/about/contributing/validmind-community.qmd

Line 8: Use parentheses judiciously. (suggestion)
Line 8: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
Line 8: Try to avoid using first-person plural like 'our'. (warning)
Line 8: Don't use exclamation points in text. (error)
Line 8: Try to avoid using first-person plural like 'us'. (warning)
Line 11: Try to avoid using first-person plural like 'our'. (warning)
Line 11: Use parentheses judiciously. (suggestion)
Line 11: Don't use exclamation points in text. (error)
Line 12: Try to avoid using first-person plural like 'our'. (warning)
Line 12: Use parentheses judiciously. (suggestion)
... and 36 more issues

site/about/deployment/_deployment-available-options.qmd

Line 1: Try to avoid using first-person plural like 'Our'. (warning)
Line 1: Use parentheses judiciously. (suggestion)
Line 1: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
Line 3: Try to avoid using first-person plural like 'We'. (warning)
Line 5: Don't put a space before or after a dash. (error)
Line 5: Use parentheses judiciously. (suggestion)
Line 5: In general, use active voice instead of passive voice ('be established'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)
Line 7: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
Line 7: Don't put a space before or after a dash. (error)
... and 1 more issues

site/about/deployment/deployment-options.qmd

Line 24: Use parentheses judiciously. (suggestion)
Line 26: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
Line 28: Try to avoid using first-person plural like 'our'. (warning)
Line 32: Don't put a space before or after a dash. (error)
Line 32: Did you really mean 'validators'? (error)
Line 34: Don't put a space before or after a dash. (error)
Line 36: Don't put a space before or after a dash. (error)
Line 38: Don't put a space before or after a dash. (error)
Line 42: Try to avoid using first-person plural like 'We'. (warning)
Line 42: Use 'data is' instead of 'data are'. (warning)
... and 12 more issues

site/about/deployment/multi-tenant-cloud.qmd

Line 13: Use 'tap' instead of 'touch'. (warning)
Line 17: Did you really mean 'deployment_'? (error)
Line 19: Use 'it's' instead of 'it is'. (suggestion)
Line 21: Use parentheses judiciously. (suggestion)
Line 29: Don't put a space before or after a dash. (error)
Line 30: Don't put a space before or after a dash. (error)
Line 31: Don't put a space before or after a dash. (error)
Line 32: Don't put a space before or after a dash. (error)
Line 39: In general, use active voice instead of passive voice ('is encrypted'). (suggestion)
Line 40: Use parentheses judiciously. (suggestion)
... and 2 more issues

site/about/deployment/virtual-private-validmind.qmd

Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 3: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
Line 14: Use 'tap' instead of 'touch'. (warning)
Line 18: Use parentheses judiciously. (suggestion)
Line 18: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
... and 8 more issues

site/about/fine-print/data-privacy-policy.qmd

Line 12: Try to avoid using first-person plural like 'our'. (warning)
Line 19: Try to avoid using first-person plural like 'we'. (warning)
Line 21: Try to avoid using first-person plural like 'Our'. (warning)
Line 21: Try to avoid using first-person plural like 'our'. (warning)
Line 21: Try to avoid using first-person plural like 'our'. (warning)
Line 26: Try to avoid using first-person plural like 'our'. (warning)
Line 26: Try to avoid using first-person plural like 'we'. (warning)
Line 26: Try to avoid using first-person plural like 'our'. (warning)
Line 34: Use 'what's' instead of 'What is'. (suggestion)
Line 36: Try to avoid using first-person plural like 'our'. (warning)
... and 49 more issues

site/about/fine-print/license-agreement.qmd

Line 9: Spell out 'READ', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'YOU', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'ARE', if it's unfamiliar to the audience. (suggestion)
... and 115 more issues

site/about/glossary/_ai.qmd

Line 1: Spell out 'IBM', if it's unfamiliar to the audience. (suggestion)
Line 1: Use parentheses judiciously. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 7: Use parentheses judiciously. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 10: In general, use active voice instead of passive voice ('were trained'). (suggestion)
Line 12: Use parentheses judiciously. (suggestion)
Line 12: Spell out 'LLM', if it's unfamiliar to the audience. (suggestion)
Line 13: Use parentheses judiciously. (suggestion)

site/about/glossary/_attestation.qmd

Line 2: Did you really mean 'validator'? (error)
Line 2: In general, use active voice instead of passive voice ('are met'). (suggestion)
Line 5: In general, use active voice instead of passive voice ('is triggered'). (suggestion)
Line 14: Did you really mean 'validators'? (error)

site/about/glossary/_developer-tools.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 2: Use 'capability' or 'feature' instead of 'functionality'. (warning)
Line 15: Use 'that's' instead of 'that is'. (suggestion)
Line 20: Try to avoid using first-person plural like 'our'. (warning)
Line 30: Use parentheses judiciously. (suggestion)
Line 32: Use parentheses judiciously. (suggestion)

site/about/glossary/_model-documentation.qmd

Line 1: Spell out 'MODEL', if it's unfamiliar to the audience. (suggestion)
Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_models.qmd

Line 4: Use parentheses judiciously. (suggestion)
Line 7: In general, use active voice instead of passive voice ('are derived'). (suggestion)
Line 7: In general, use active voice instead of passive voice ('is achieved'). (suggestion)
Line 11: Use parentheses judiciously. (suggestion)
Line 15: Use 'it's' instead of 'it is'. (suggestion)
Line 15: In general, use active voice instead of passive voice ('is decommissioned'). (suggestion)
Line 15: Use parentheses judiciously. (suggestion)
Line 22: Use parentheses judiciously. (suggestion)
Line 22: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
Line 23: In general, use active voice instead of passive voice ('are developed'). (suggestion)

site/about/glossary/_monitoring.qmd

Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_mrm.qmd

Line 3: Spell out all ordinal numbers ('1st') in text. (error)
Line 3: Put a nonbreaking space between the number and the unit in '1s'. (error)
Line 4: Don't use plurals in parentheses such as in 'unit(s)'. (error)
Line 4: Use parentheses judiciously. (suggestion)
Line 4: Put a nonbreaking space between the number and the unit in '1s'. (error)
Line 4: Spell out all ordinal numbers ('1st') in text. (error)
Line 4: Use 'they're' instead of 'they are'. (suggestion)
Line 6: Spell out all ordinal numbers ('2nd') in text. (error)
Line 7: Spell out all ordinal numbers ('2nd') in text. (error)
Line 7: Did you really mean 'validators'? (error)
... and 11 more issues

site/about/glossary/_validation-reports.qmd

Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_validmind-features.qmd

Line 7: In general, use active voice instead of passive voice ('are used'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/_validmind.qmd

Line 3: In general, use active voice instead of passive voice ('are intertwined'). (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 6: Use 'open source' instead of 'open-source'. (warning)
Line 6: Use parentheses judiciously. (suggestion)
Line 6: Did you really mean 'overfit'? (error)
Line 8: Use parentheses judiciously. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Did you really mean 'APIs'? (error)

site/about/glossary/glossary.qmd

Line 7: Spell out 'NEW', if it's unfamiliar to the audience. (suggestion)
Line 7: Spell out 'TERM', if it's unfamiliar to the audience. (suggestion)
Line 7: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 7: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 7: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Use 'for example' instead of 'e.g.'. (error)
Line 10: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
Line 10: Spell out 'TERMS', if it's unfamiliar to the audience. (suggestion)
... and 9 more issues

site/about/glossary/key_concepts/_docs.qmd

Line 4: Use 'app' instead of 'application'. (warning)

site/about/glossary/key_concepts/_inputs.qmd

Line 2: In general, use active voice instead of passive voice ('be evaluated'). (suggestion)
Line 4: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
Line 4: Use parentheses judiciously. (suggestion)
Line 5: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 6: In general, use active voice instead of passive voice ('is used'). (suggestion)
Line 7: In general, use active voice instead of passive voice ('is used'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/key_concepts/_key-concepts.qmd

Line 1: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 5: Use 'for example' instead of 'e.g.'. (error)
Line 5: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/key_concepts/_metrics.qmd

Line 2: Use 'don't' instead of 'do not'. (suggestion)
Line 2: In general, use active voice instead of passive voice ('be registered'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be used'). (suggestion)
Line 4: In general, use active voice instead of passive voice ('be thought'). (suggestion)

site/about/glossary/key_concepts/_monitoring-template.qmd

Line 2: In general, use active voice instead of passive voice ('be tracked'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be conducted'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be displayed'). (suggestion)
Line 4: Did you really mean 'boilerplates'? (error)

site/about/glossary/key_concepts/_outputs.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 2: 's.D' should have one space. (error)

site/about/glossary/key_concepts/_parameters.qmd

Line 2: In general, use active voice instead of passive voice ('be passed'). (suggestion)

site/about/glossary/key_concepts/_template.qmd

Line 2: In general, use active voice instead of passive voice ('be run'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be displayed'). (suggestion)
Line 4: Did you really mean 'boilerplates'? (error)

... and 574 more files with issues

github-actions · 2025-06-17T00:27:15Z

Lighthouse check results

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

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: da25746

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.75	0.73	1.00	0.89
/get-started/get-started.html	0.76	0.87	1.00	0.80
/guide/guides.html	0.76	0.86	1.00	0.90
/index.html	0.79	0.84	1.00	0.80
/releases/all-releases.html	0.85	0.88	1.00	0.80
/support/support.html	0.82	0.86	1.00	0.90
/training/training.html	0.73	0.80	0.96	0.80

nrichers

FYI, there still was a bug in the code when generating the XML sitemap on prod and staging, though the HTML one was fine.

The code was messy — I originally created only an XML sitemap and then the HTML one was an afterthought which resulted in some duplication where base URLs and prefixes were defined. I pushed 602ba25 to clean that up a bit.

Tested on your PR branch, main, staging, and prod and both the HTML and XML sitemaps now contain the correct URLs.

Maybe just retest my fix before merging? LGTM otherwise. 🚀

github-actions · 2025-06-17T00:40:06Z

Validate docs site

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

fixed the PR_review issue

b60f209

LoiAnsah requested a review from nrichers June 16, 2025 18:18

LoiAnsah self-assigned this Jun 16, 2025

LoiAnsah added the bug Something isn't working label Jun 16, 2025

LoiAnsah and others added 5 commits June 16, 2025 14:52

edit Makefile

dda6933

edit Makefile

1f955e8

edit Makefile

97decef

edit Makefile

3fd7022

Fix XML sitemap bug, simplify code

602ba25

nrichers approved these changes Jun 17, 2025

View reviewed changes

nrichers added the internal Not to be externalized in the release notes label Jun 17, 2025

LoiAnsah merged commit ac990db into main Jun 17, 2025
5 of 6 checks passed

LoiAnsah deleted the ama8636/sc-10755/remove-pr-previews-from-sitemap-urls branch June 17, 2025 15:10

Fixed the PR_review issue #755

Fixed the PR_review issue #755

Uh oh!

Conversation

LoiAnsah commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Internal Notes for Reviewers

How to test

Uh oh!

github-actions bot commented Jun 16, 2025

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Jun 17, 2025

Vale source linter

site/404.qmd

site/about/contributing/style-guide/conventions.qmd

site/about/contributing/style-guide/style-guide.qmd

site/about/contributing/style-guide/voice-and-tone.qmd

site/about/contributing/validmind-community.qmd

site/about/deployment/_deployment-available-options.qmd

site/about/deployment/deployment-options.qmd

site/about/deployment/multi-tenant-cloud.qmd

site/about/deployment/virtual-private-validmind.qmd

site/about/fine-print/data-privacy-policy.qmd

site/about/fine-print/license-agreement.qmd

site/about/glossary/_ai.qmd

site/about/glossary/_attestation.qmd

site/about/glossary/_developer-tools.qmd

site/about/glossary/_model-documentation.qmd

site/about/glossary/_models.qmd

site/about/glossary/_monitoring.qmd

site/about/glossary/_mrm.qmd

site/about/glossary/_validation-reports.qmd

site/about/glossary/_validmind-features.qmd

site/about/glossary/_validmind.qmd

site/about/glossary/glossary.qmd

site/about/glossary/key_concepts/_docs.qmd

site/about/glossary/key_concepts/_inputs.qmd

site/about/glossary/key_concepts/_key-concepts.qmd

site/about/glossary/key_concepts/_metrics.qmd

site/about/glossary/key_concepts/_monitoring-template.qmd

site/about/glossary/key_concepts/_outputs.qmd

site/about/glossary/key_concepts/_parameters.qmd

site/about/glossary/key_concepts/_template.qmd

Uh oh!

github-actions bot commented Jun 17, 2025

Lighthouse check results

Uh oh!

nrichers left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 17, 2025

Validate docs site

Uh oh!

Uh oh!

Uh oh!

LoiAnsah commented Jun 16, 2025 •

edited

Loading