-
Notifications
You must be signed in to change notification settings - Fork 4
New Homepage integration #743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
New Homepage integration #743
Conversation
…o ama8636/sc-10161/test-generating-docs-site-artifacts-via-mcp
PR SummaryThis pull request introduces several new files and updates to the ValidMind platform's documentation and styling. Key changes include:
Test Suggestions
|
…o ama8636/sc-10161/test-generating-docs-site-artifacts-via-mcp
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@LoiAnsah this is a solid and substantial PR — great work pulling all of this together. 🙌
I’ve left a few comments and suggestions to address before I review again. Once you’ve made the changes, please re-request review by clicking the icon next to my name in the reviewers section.
Also, your PR needs at least some labels — I would recommend |
@nrichers Thank you for the review. I will go through each section you highlighted and fix the issues. |
PR SummaryThis pull request introduces several enhancements to the ValidMind documentation and user interface. Key changes include:
These changes aim to improve the user experience by providing clearer navigation, updated visual elements, and new resources for getting started with the platform. Test Suggestions
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still reviewing your latest implementation of the new home page and one item we need to sort out for sure is the footer:
- Currently the links 404 when they should work
- The footer is lifted from the main site but it really should have more content that is related to the docs site itself, as it should serve as a mini sitemap (and also link to the new sitemap.html)
Let's do a bit of brainstorming about what would make sense to include here, but there is some prior art in this frame of a working board we had in Miro: https://miro.com/app/board/uXjVIUysCKM=/?moveToWidget=3458764622028594416&cot=14
PR SummaryThis pull request introduces several enhancements to the ValidMind documentation and user interface. Key changes include:
These changes aim to improve the user experience by providing clearer navigation, more comprehensive guides, and a visually appealing interface. Test Suggestions
|
Hi @nrichers, The branch is now up to date with my latest changes. ![]() I am having a problem moving the cookie preferences to the corner. Will try fixing it but I am open to any hint. |
As discussed at our standup, I'll re-review when you have made some more changes to the footer, @LoiAnsah. Please do ask for me to help out with changes where you think it would be helpful — for placement of |
@LoiAnsah one last comment before I wait for your request to re-review: please check that there are no WARN messages in the Quarto output that need to be resolved? E.g. the current version of your PR has some broken links:
|
@nrichers Hi Nik, I have pushed my latest changes for the footer. |
7e63ebe
to
9edeea7
Compare
Vale source linterShow first 30 files with issuessite/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
... and 582 more files with issues |
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: f338903 Modify the workflow to check a different depth:
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ARRGH! Wrong PR, this one still needs changes, which I will handle. Please ignore ...
Internal Notes for Reviewers
https://app.shortcut.com/validmind/story/10590/implement-new-homepage-design
Homepage:
I attempted to update our homepage using our most recent design.
Design:

My implementation:

As you can see, I am missing some components:
Footer: I have had issues making it appear on all pages.
header: removing the search item at the very right
text: Centring the text under "Validmind Tour"
How to test
Since the online preview won't display the notebook iFrames correctly (it pulls the relative link from the root of the docs-demo repo rather than the PR branch):
Grab this PR: gh pr checkout 743
Make sure you're in the site directory if you're not already: cd site
Pull up a live preview: quarto preview
Review the homepage of the doc site.