Skip to content

Auto-generate docs schema and render config reference from JSON Schema#44

Draft
Copilot wants to merge 12 commits intomainfrom
copilot/add-documentation-guide-reference
Draft

Auto-generate docs schema and render config reference from JSON Schema#44
Copilot wants to merge 12 commits intomainfrom
copilot/add-documentation-guide-reference

Conversation

Copy link

Copilot AI commented Feb 1, 2026

Documentation needed to render the configuration reference from JSON Schema and keep it synchronized with code comments; CI should generate the schema automatically before building docs.

  • Schema-driven reference

    • Render /docs/config/reference from JSON Schema via a reusable MDX component.
    • Persist the generated schema in docs static assets for deterministic builds.
  • Schema descriptions

    • Add field-level doc comments across core config structs so schema descriptions are human-readable.
  • Docs CI automation

    • Generate schema in the docs workflow before the build (Rust toolchain setup, explicit package run).

Example (schema embed in reference page):

import SchemaReference from '@site/src/components/SchemaReference';

<SchemaReference />

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Copilot AI changed the title [WIP] Add detailed guide and reference pages to documentation Add detailed guide and configuration reference docs Feb 1, 2026
Copilot AI requested a review from spacemeowx2 February 1, 2026 05:54
@spacemeowx2
Copy link
Owner

@copilot The job failed because the workflow uses a deprecated version of actions/cache (@v1), which is no longer supported. To fix this, update all references of actions/cache@v1 in your workflow file to actions/cache@v3 or actions/cache@v4.

For example, change:

  • name: Cache Cargo
    uses: actions/cache@v1
    with:
    path: ~/.cargo
    key: ${{ matrix.os }}-stable-cargo-v1
    restore-keys: |
    ${{ matrix.os }}-stable-cargo-v1
    to:

  • name: Cache Cargo
    uses: actions/cache@v3
    with:
    path: ~/.cargo
    key: ${{ matrix.os }}-stable-cargo-v1
    restore-keys: |
    ${{ matrix.os }}-stable-cargo-v1
    Apply the same replacement for every occurrence in your .github/workflows/rust.yml file. This will resolve the job failure caused by the deprecated action.

Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Copilot AI changed the title Add detailed guide and configuration reference docs Schema‑driven config reference with synced field descriptions Feb 1, 2026
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Copilot AI changed the title Schema‑driven config reference with synced field descriptions Schema-driven config reference with synced descriptions + CI cache fix Feb 11, 2026
Copilot AI and others added 8 commits February 11, 2026 16:19
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Co-authored-by: spacemeowx2 <8019167+spacemeowx2@users.noreply.github.com>
Copilot AI changed the title Schema-driven config reference with synced descriptions + CI cache fix Auto-generate docs schema and render config reference from JSON Schema Feb 11, 2026
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