Skip to content

Rewrite README for Mintlify and restore migration scripts - #4837

Open
lperry25 wants to merge 1 commit into
mintlify/migrationfrom
laura/missing-readme-scripts
Open

Rewrite README for Mintlify and restore migration scripts#4837
lperry25 wants to merge 1 commit into
mintlify/migrationfrom
laura/missing-readme-scripts

Conversation

@lperry25

Copy link
Copy Markdown
Contributor

The mintlify-docs directory removal (#4833) dropped two things that existed nowhere else: the Mintlify dev workflow documented in its README, and the Jekyll-to-MDX conversion scripts.

  • Rewrite the root README: replace the stale Jekyll/Ruby build instructions, sidebar.yml references and feed-pipeline appendix (infra no longer on this branch) with the Mintlify workflow (mint dev, GitHub-app publishing, docs.json navigation/redirects), keeping the still-relevant writing guidance (guides vs references, categorization, maintainability, style, Javadoc links) with linking conventions updated for MDX.
  • Restore the conversion helpers to scripts/ (html_to_mdx.py etc.) for future syncs from master.

The deleted mintlify-docs/LICENSE was the Mintlify starter-kit MIT license, not a Vespa license, and is intentionally not restored.

I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner.

The mintlify-docs directory removal (#4833) dropped two things that
existed nowhere else: the Mintlify dev workflow documented in its
README, and the Jekyll-to-MDX conversion scripts.

- Rewrite the root README: replace the stale Jekyll/Ruby build
  instructions, sidebar.yml references and feed-pipeline appendix
  (infra no longer on this branch) with the Mintlify workflow
  (mint dev, GitHub-app publishing, docs.json navigation/redirects),
  keeping the still-relevant writing guidance (guides vs references,
  categorization, maintainability, style, Javadoc links) with linking
  conventions updated for MDX.
- Restore the conversion helpers to scripts/ (html_to_mdx.py etc.)
  for future syncs from master.

The deleted mintlify-docs/LICENSE was the Mintlify starter-kit MIT
license, not a Vespa license, and is intentionally not restored.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 20, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
vespaai 🟢 Ready View Preview Aug 20, 2026, 1:45 PM

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

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.

1 participant