Skip to content

Conversation

@seesharprun
Copy link
Contributor

@seesharprun seesharprun commented Dec 2, 2025

This pull request refactors the entire documentation system to use Markdown files with these major changes:

  • All documentation is pulled from the documentdb/docs repository
  • Reference documentation is pulled from Markdown with YAML front matter metadata instead of YAML files directly. This PR also updates the codebase to support this new format.
  • Articles are pulled from Markdown with YAML files for navigation
  • Article metadata is pulled from YAML front matter or partial files
  • This update also includes a rework of the navigation menu for reference content to closer match the expected structure of reference documentation.

You can review a sample build of the Next.js site in my fork here:

Test locally

  1. Clone this code

  2. Get dependencies with npm install

  3. Run site

    • Debug with npm run dev

    • Statically build and host the site using npm run build and npm run start

  4. Check all new documentation

@abinav2307 abinav2307 self-assigned this Dec 11, 2025
@seesharprun seesharprun marked this pull request as draft December 12, 2025 03:59
@seesharprun
Copy link
Contributor Author

This PR will need to be reworked as the content now comes from https://github.com/documentdb/docs.

I'll mark as ready again once the PR has been updated.

@seesharprun seesharprun marked this pull request as ready for review December 22, 2025 17:10
@seesharprun seesharprun marked this pull request as draft December 22, 2025 17:10
@seesharprun seesharprun marked this pull request as ready for review December 31, 2025 00:00
@seesharprun
Copy link
Contributor Author

@abinav2307, this is the pull request to pull documentation from documentdb/docs and render it on your site.

@abinav2307 abinav2307 merged commit 55972fa into documentdb:main Jan 7, 2026
2 checks passed
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.

2 participants