Skip to content

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 11, 2026

Pull Request Description

What and why?

This PR publishes some recent docs updates to prod.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

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 and others added 18 commits February 5, 2026 11:29
- Update README to point to validmind/skills for the documentation skill
- Add installation instructions for Cursor Settings import
- Remove local .mdc rule file (now lives in validmind/skills)

[sc-14457]

Co-authored-by: Cursor <cursoragent@cursor.com>
…ab-integration-docume

Update GitLab integration documentation
* Auto-updating sidebar script

* Updating developer/_sidebar.yaml with updated script
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
…github.com:validmind/documentation into nrichers/sc-14457/migrate-docs-automation-to-skill
…s-automation-to-skill

Migrate docs automation to skills repo
@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 11, 2026
@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several key improvements to the documentation workflow and UI integrations:

  1. Removal of legacy Cursor rule and skill files (create-user-documentation) to streamline the documentation creation process. The references in the README have been updated accordingly to point to the new documentation skill.

  2. Updates to the integration documentation for GitLab. The configuration details have been refined to clarify the GitLab project ID/path, GitLab instance URL, and token requirements. A new section on synchronizing models with GitLab has been added along with detailed step-by-step instructions and screenshots.

  3. Enhancement of the developer sidebar for code samples. The existing single wildcard entry has been replaced with a more detailed, categorized list of code sample directories. The sidebar now displays sections for various topics such as Agents, Capital markets, Code explainer, Credit risk, and more. This change is supported by a new Python script (update_code_samples_sidebar.py) that automatically generates this list in alphabetical order, ensuring consistent and correct capitalization (e.g. fixing "NLP and LLM").

  4. Minor modifications to the Makefile to invoke the sidebar update script, ensuring the sidebar is kept up-to-date with any changes within the code samples directory structure.

Overall, these changes aim to simplify documentation generation, improve user guidance through updated integrations instructions, and maintain a cleaner, more informative sidebar for developers.

Test Suggestions

  • Render the site locally to verify that the updated GitLab integration pages display correctly and that the new screenshots are properly referenced.
  • Run the updated Makefile to ensure that the update_code_samples_sidebar.py script executes without errors and updates the sidebar as expected.
  • Test the new documentation skill by invoking it in a Cursor chat session to confirm that it provides the intended prompts and guidance.
  • Verify that the removed rule files no longer interfere with the documentation generation process and that all links in the README now point to the correct skill reference.

@github-actions
Copy link
Contributor

Validate docs site

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

@nrichers nrichers merged commit ec6512d into prod Feb 11, 2026
9 of 11 checks passed
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