Skip to content

Generated Reference Workflows

Reference pages should be refreshed with the owning generator rather than hand edited after the fact.

Generated Reference Model

flowchart TD
    Source[Source registries and code] --> Generate[Generate reference artifacts]
    Generate --> Review[Review generated outputs]
    Review --> Publish[Publish or embed in docs]
    Publish --> Use[Use as reference surfaces]

    Source --> Authored[Authored truth]
    Generate --> Derived[Derived reference]
    Authored -. must stay aligned with .-> Derived

This page exists so generated reference content stays visibly downstream of authored truth. When a maintainer edits generated reference output by hand, the repository loses the ability to explain how that page was produced.

Source Anchors

Main Takeaway

Generated reference workflows keep Atlas reference docs aligned with the repository's authored registries and command surfaces. The right fix for drift is to update the source or the generator, then regenerate and review the derived output.