Skip to main content
Batoi UIF Docs

Contributing

Maintain Batoi UIF documentation, examples, and source references consistently.

Version 3.0.0 Version 3 active maintenance Reviewed Aug 11, 2026 Next review Nov 11, 2026

Owner: Batoi Engineering Reviewed by: Batoi UIF Maintainers Source revision: b2f3478

Browse Batoi UIF Documentation Contributing

Contributing

Batoi UIF documentation is maintained as reviewed, source-controlled Markdown.

Editing Rules

  • Keep docs source-controlled.
  • Keep public documentation changes scoped to the maintained Documentation collection and its renderer contract.
  • Keep long-form docs out of route files.
  • Update examples and docs together when behavior changes.
  • Use clear public language and avoid internal implementation leakage.

Adding a Page

1. Add the Markdown page to the maintained UIF documentation collection. 2. Add front matter with title, summary, and order. 3. Register the page in the public documentation navigation. 4. Link to examples or GitHub where helpful. 5. Run the documentation release checks before publication.

Planning a Blog Article

Prepare related editorial content through Batoi's reviewed publishing workflow, keeping developer documentation focused on durable technical guidance.