Skip to main content

Document metadata

Status
Maintained
Approval
Approved
Version
1.0
Classification
PUBLIC
Owner
Lightning IT Documentation Maintainers
Approver
Lightning IT Product Owners
Audience
content maintainers, contributors
Last reviewed
Next review
(Annual)

Develop ModuLix content

Develop code-specific behavior in the public component repository that owns it. This documentation repository owns portfolio concepts, public workflows, and cross-component guidance; it should not become a second copy of role defaults or test instructions.

Select the owning repository

Design the change

Keep one bounded responsibility per change. Document:

  • the desired state and explicit non-goals;
  • supported input types, defaults, validation, and sensitive values;
  • expected target changes and privilege;
  • idempotence and check-mode behavior when supported;
  • preflight, verification, safe-stop, and recovery expectations;
  • compatibility impact and deprecation needs; and
  • the tests that demonstrate the contract.

Never add realistic customer or company infrastructure data to fixtures. Use example.com, host01.example.com, 192.0.2.10, or another permitted documentation-only value.

Work with the repository contract

Read the nearest contributor and agent instructions in the component repository, create a focused branch, and use its locked toolchain. Run the repository's own format, lint, unit, scenario, integration, security, and release checks as applicable. Do not invent a shared command when repositories publish different test profiles.

Submit code, role documentation, release notes, and migration guidance in the same reviewed change when behavior or inputs change. Generated documentation must identify its public source and immutable commit.

Continue with the testing model and the site-wide contribution guide.