Skip to content

Prepare schema documentation for automated sync#1215

Closed
DaedalusG wants to merge 0 commit into
mainfrom
wg/rel/extract-custom-description-from-docs-schemas
Closed

Prepare schema documentation for automated sync#1215
DaedalusG wants to merge 0 commit into
mainfrom
wg/rel/extract-custom-description-from-docs-schemas

Conversation

@DaedalusG
Copy link
Copy Markdown
Contributor

Purpose

This PR prepares the documentation for automated schema synchronization by extracting valuable custom commentary from schema sections and organizing it into dedicated subsections.

Changes Made

Content Extraction & Organization

  • Extracted custom commentary from all 13 schema sections (site config, settings, and code hosts)
  • Organized content into logical subsections:
    • Configuration Notes
    • Security Considerations
    • Common Examples
    • Best Practices

Schema Block Preparation

  • Cleaned schema sync areas to contain only markers and placeholder comments
  • Prepared for automation - schema blocks now ready for raw JSON replacement from sourcegraph/sourcegraph repo
  • Preserved all markers for the automated sync tooling

Benefits

  1. Preserves valuable content - All human-written security warnings, configuration guidance, and practical examples are maintained
  2. Improves organization - Content is now in dedicated, discoverable sections rather than embedded in schema comments
  3. Enables automation - Schema blocks are prepared for simple raw JSON replacement during releases
  4. Better user experience - Documentation is more structured and easier to navigate

Next Steps

This is preparatory work for the automated schema sync tooling being developed in . Once this PR is merged, the tooling can safely replace schema sections with raw JSON from the monorepo while preserving all the valuable educational content.

Files Modified

  • 13 schema documentation files across admin/config and admin/code_hosts
  • Net result: Better organized content (-1,748 lines in schema blocks, +1,100 lines in organized sections)

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 26, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 26, 2025 1:48am

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