Skip to content

docs: fix structure outputs blog format#368

Merged
johnnygreco merged 1 commit into
mainfrom
docs/structured-outputs-from-nemotron
Mar 4, 2026
Merged

docs: fix structure outputs blog format#368
johnnygreco merged 1 commit into
mainfrom
docs/structured-outputs-from-nemotron

Conversation

@johnnygreco

@johnnygreco johnnygreco commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rename the structured outputs dev note file to a Nemotron-specific slug and update the Dev Notes nav entry.
  • Add a <!-- more --> marker near the top of the post so blog previews truncate cleanly.
  • Keep content unchanged otherwise (rename detected at 99% similarity).

Test plan

  • Confirm mkdocs.yml nav entry opens Structured Outputs from Nemotron correctly.
  • Verify blog preview/excerpt behavior renders as expected with the new <!-- more --> marker.

Align the dev note path/nav with the Nemotron-specific title and add a blog excerpt marker for cleaner post previews.
@johnnygreco johnnygreco requested a review from a team as a code owner March 4, 2026 20:23
@johnnygreco johnnygreco changed the title docs: rename structured outputs dev note for Nemotron docs: fix structure outputs blog format Mar 4, 2026

Using [NeMo Data Designer](https://github.com/NVIDIA-NeMo/DataDesigner), an orchestration framework for generating high-quality synthetic data at scale, we built an iterative pipeline that generates diverse, schema-constrained structured outputs across JSON, YAML, and XML. Through multiple rounds of prompt refinement, rejection sampling, and programmatic validation, we produced a 9,949-sample dataset of verified structured output training data.

<!-- more -->

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is importatn!

@greptile-apps

greptile-apps Bot commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR renames the structured-outputs.md dev-note post to structured-outputs-from-nemotron.md (99% similarity rename), adds a <!-- more --> excerpt marker after the opening paragraph, updates the mkdocs.yml nav to reference the new filename with a descriptive label, and reorders the Dev Notes nav items (most-recent first).

  • Rename & slug change: Because mkdocs.yml uses post_url_format: "{slug}" and no explicit slug: is set in the post's front matter, the public URL will change from .../structured-outputs to .../structured-outputs-from-nemotron. This is intentional per the PR description, but it is a breaking link change for anyone who has already bookmarked or shared the old URL. Consider adding an explicit slug: key in the front matter if backwards-compatibility with the old URL is ever needed, or noting this in the PR test plan.
  • <!-- more --> placement: Correctly placed after the first summary paragraph, which will produce a concise one-paragraph excerpt in the blog listing.
  • Nav reordering: Entries are now ordered most-recent first (Structured Outputs 2026-02-18 → Deep Research → RQA → Design Principles), which is a reasonable editorial choice.

Confidence Score: 5/5

  • This PR is safe to merge — it is a documentation-only rename with a minor content addition.
  • Changes are limited to renaming one Markdown post file and updating the corresponding nav entry in mkdocs.yml. The only content addition is a <!-- more --> excerpt marker. No application code, tests, or configuration logic is affected.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/devnotes/posts/structured-outputs-from-nemotron.md File renamed from structured-outputs.md; only addition is a <!-- more --> excerpt marker after the opening paragraph — content is otherwise unchanged.
mkdocs.yml Nav entry updated to point to the renamed file and given a descriptive label; Dev Notes entries reordered (most-recent first). No structural issues.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[mkdocs.yml Nav] --> B[Dev Notes]
    B --> B0[devnotes/index.md]
    B --> C["Structured Outputs from Nemotron\n(NEW — structured-outputs-from-nemotron.md)"]
    B --> D[Deep Research Trajectories\ndeep-research-trajectories.md]
    B --> E[RQA Dataset\nrqa.md]
    B --> F[Design Principles\ndesign-principles.md]

    subgraph "File Rename"
      OLD["structured-outputs.md\n(removed)"] -->|"99% similarity rename\n+ adds &lt;!-- more --&gt;"| NEW["structured-outputs-from-nemotron.md\n(added)"]
    end
Loading

Last reviewed commit: 038da88

Comment thread mkdocs.yml
Comment on lines +69 to +72
- Structured Outputs from Nemotron: devnotes/posts/structured-outputs-from-nemotron.md
- Deep Research Trajectories: devnotes/posts/deep-research-trajectories.md
- RQA Dataset: devnotes/posts/rqa.md
- Design Principles: devnotes/posts/design-principles.md

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably makes sense to put the newest at the top

@johnnygreco johnnygreco merged commit be91adc into main Mar 4, 2026
53 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