Batoi UIF Docs

Contributing

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

Start Reading Open GitHub
On this page

Contributing

Batoi UIF documentation is maintained as Markdown under rad/docs/uif/.

Editing Rules

  • Keep docs source-controlled.
  • Keep route code in rad/ms/resources/.
  • 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 a Markdown file under rad/docs/uif/. 2. Add front matter with title, summary, and order. 3. Register the page in route.docs.php. 4. Link to examples or GitHub where helpful. 5. Run PHP lint on changed route files.

Planning a Blog Article

Draft blog articles under specs/blog/.

They can later be manually published through the website blog section.