Skip to content

[DOCS] Add documentation for op-deployer intent file configuration #1505

@seromenho

Description

@seromenho

Description

It would be helpful to have documentation for OP-Deployer configurations in a similar format to the deploy-config file, detailing all the possible properties and values for the intent file.

Currently, for non-documented properties, users must manually inspect the op-deployer codebase to identify relevant properties and their usage. Clear documentation would streamline this process and improve the developer experience.

This documentation should provide clarity on available options, especially for key configurations like Alt-DA mode, Fault Proofs, and other relevant settings.

Acceptance criteria

  • Create a dedicated page or section detailing the intent file configuration structure.
  • Include explanations for each possible property and its values.
  • Provide examples for common configurations such as enabling/disabling Fault Proofs and setting up Alt-DA mode.
  • Ensure documentation aligns with the latest op-deployer release.
  • (Optional but ideal) Specify the op-deployer version that introduces or modifies each configuration property to improve clarity for developers working with older versions.

User stories

  • As an OP Stack chain operator, I want to reference clear documentation for the op-deployer intent file so that I can confidently configure my deployment.
  • As a developer using Alt-DA, I need to know how to set up the intent file to ensure my custom data availability solution is properly integrated.

Resources and support

  • The deploy-config documentation serves as a good reference model.

Action items

  • Identify the complete list of intent file properties.
  • Create documentation with descriptions, value types and examples.
  • Publish the new documentation and update relevant links across the OP Stack documentation site.

Metadata

Metadata

Assignees

No one assigned

    Labels

    community-requestdocs updates requested by community or OP collectivedocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions