Skip to content

Upgrade Leadtype docs metadata - #48

Merged
KayleeWilliams merged 1 commit into
mainfrom
KayleeWilliams/Nautilus
Jun 5, 2026
Merged

Upgrade Leadtype docs metadata#48
KayleeWilliams merged 1 commit into
mainfrom
KayleeWilliams/Nautilus

Conversation

@KayleeWilliams

Copy link
Copy Markdown
Collaborator

Summary

  • Upgrade Leadtype to 0.2.1 and migrate docs config to the 0.2 metadata model.
  • Add config-owned navigation, llms.sections, organization/product metadata, and enriched release bundle generation.
  • Fix docs metadata/readability gaps by adding shared warning frontmatter, code fence languages, and package SKILL.md publishing.

Impact

Generated docs now include the Leadtype 0.2 agent surfaces and metadata expected by site and package bundle generation, including AGENTS.md/SKILL.md bundle output and JSON-LD-ready page metadata.

Validation

  • bun run check
  • bunx leadtype generate --src . --out /private/tmp/dsar-leadtype-site --base-url https://example.com --enrich-git --json
  • bunx leadtype generate --bundle --src . --out /private/tmp/dsar-leadtype-bundle --name dsar --enrich-git --json
  • bunx leadtype score --src . --out /private/tmp/dsar-leadtype-site -> 100/100

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 39237554-ec82-486c-af49-e22be3117cdf

📥 Commits

Reviewing files that changed from the base of the PR and between 3cf88fe and f0162ee.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (8)
  • docs/_shared/alpha-warning.mdx
  • docs/docs.config.ts
  • docs/reference/storage/filesystem.mdx
  • docs/reference/storage/index.mdx
  • docs/reference/storage/s3.mdx
  • docs/reference/storage/vercel-blob.mdx
  • package.json
  • packages/dsar/package.json

Disabled knowledge base sources:

  • Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Summary by CodeRabbit

Release Notes

  • Documentation

    • Enhanced documentation configuration with improved navigation structure and LLM-assisted content support.
    • Fixed code formatting in storage reference guides for better readability.
  • Chores

    • Updated build scripts and development dependencies to improve release automation.
    • Added skill manifest to published package files.

Walkthrough

This PR restructures documentation configuration to support LLM-assisted features and site navigation, adds metadata to shared components, standardizes code formatting across storage references, and updates release tooling to publish generated artifacts with enhanced git metadata via leadtype.

Changes

Documentation and Release Tooling

Layer / File(s) Summary
Alpha warning metadata and docs configuration structure
docs/_shared/alpha-warning.mdx, docs/docs.config.ts
Adds frontmatter metadata (title, description) to the alpha-warning shared component. Restructures docs.config.ts to introduce llms.sections for Overview and Agent Guidance, a hierarchical navigation tree defining routes for guides, architecture, integrations (with inbound/outbound/storage/rate-limit/auth), and reference (with API/developer/persistence/storage/testing/errors), and updates product fields from summary-style to metadata-oriented (category, kind, repository, tagline).
Storage documentation code-fence standardization
docs/reference/storage/filesystem.mdx, docs/reference/storage/index.mdx, docs/reference/storage/s3.mdx, docs/reference/storage/vercel-blob.mdx
Updates code fence opening specifiers from generic triple-backtick to explicitly typed ```text across four storage reference documents for deterministic key-format examples.
Release script and package configuration updates
package.json, packages/dsar/package.json
Updates root release and release:canary scripts to add --enrich-git flag to leadtype generate and remove packages/dsar/SKILL.md during packaging. Bumps leadtype dev dependency from ^0.1.1 to 0.2.1. Adds SKILL.md to the dsar package files array for publication.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • inthhq/dsar#39: Updates Leadtype docs setup with similar changes to docs/_shared/alpha-warning.mdx, docs/docs.config.ts, and package.json release script modifications for leadtype generate --enrich-git.
  • inthhq/dsar#3: Further updates docs/_shared/alpha-warning.mdx with title/description frontmatter and adjusts docs CI behavior around alpha-warning checks.

Poem

🐰 Docs shine bright with metadata adorned,
Config blooms with navigation reborn,
Code fences dressed in text attire,
Leadtype enriched—the release takes flight!
All artifacts packaged, LLMs inspired! ✨

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch KayleeWilliams/Nautilus

Comment @coderabbitai help to get the list of available commands and usage tips.

@KayleeWilliams
KayleeWilliams marked this pull request as ready for review June 5, 2026 14:50
@pullfrog

pullfrog Bot commented Jun 5, 2026

Copy link
Copy Markdown

This run was cancelled 🛑

The workflow was cancelled before completion. Please check the link below for details.

Pullfrog  | View workflow run | via Pullfrog𝕏

@KayleeWilliams
KayleeWilliams merged commit 717f35f into main Jun 5, 2026
9 of 10 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.

1 participant