Skip to content

Wiki Convention

Kadyapam edited this page Jun 2, 2026 · 1 revision

Wiki Convention

How the ai-meta wiki (this one) relates to the per-repo wikis.

The split

  • Per-repo wikis (noetl/noetl/wiki, noetl/server/wiki, noetl/worker/wiki, etc.) document that repo's public surface — its API, its module layout, its operational knobs. Mirror the code at the wiki level.
  • This wiki (noetl/ai-meta/wiki) documents the system of repos — cross-repo umbrellas, the ecosystem map, release history, session decisions, and how agents coordinate across them.

When in doubt: if the content is about a single submodule's internals, it belongs in that submodule's wiki. If it spans repos or tracks platform-wide state, it belongs here.

What lives here

Page What
Home Dashboard — active umbrellas, ecosystem map, release pointer
Repo Map Every submodule, its role, its current version, its wiki
Releases Per-repo release log with GitHub Release URLs
Sessions Log Chronological log of agent sessions and what landed
Umbrella: * One page per active ai-task umbrella issue
Issue Tracking Pointer to agents/rules/issue-tracking.md
Wiki Convention This page
Handoffs Pointer to agents/rules/handoffs.md
Deployment Validation Pointer to agents/rules/deployment-validation.md
Execution Model Pointer to agents/rules/execution-model.md
Observability Pointer to agents/rules/observability.md

What does NOT live here

  • The Python API reference, the DSL semantics → noetl/noetl wiki.
  • The Rust server's route handlers, the event envelope schema → noetl/server wiki.
  • The Rust worker's main loop, the metrics surface → noetl/worker wiki.
  • The KEDA scaler manifest details, the Helm chart values → noetl/ops wiki.
  • The Docusaurus engineer-facing architecture (ephemeral blueprints, ADRs, Appendix H) → noetl/docs site at https://noetl.dev/docs.

If you find yourself writing repo-specific reference content here, stop and move it to the right wiki.

Maintenance

This wiki is a git submodule of noetl/ai-meta at repos/ai-meta-wiki/. Updates ride the same pattern as other wiki updates per agents/rules/wiki-maintenance.md:

  1. Edit pages in repos/ai-meta-wiki/.
  2. Commit + push to noetl/ai-meta.wiki.git master.
  3. Bump the submodule pointer in ai-meta with a chore(sync): bump ai-meta-wiki to <sha> commit.

Per-session expectation:

  • Add a Sessions Log entry at the top when the session lands meaningful work (issues opened, PRs merged, pointer bumps, design decisions).
  • Refresh Home when the active-umbrella table changes (new umbrella, closed umbrella, status change).
  • Update Releases when a submodule pointer bump references a new tagged release.
  • Touch the relevant Umbrella-* page when the umbrella's status moves — append a line under "Recent activity" with the date + concrete change.

Cross-link discipline

When you link from this wiki to a per-repo wiki page, use the full URL: https://github.com/noetl/<repo>/wiki/<page-slug>. Internal links inside this wiki use bare slugs like [Home](Home).

When a per-repo wiki page references this dashboard, link to specific pages here (e.g. https://github.com/noetl/ai-meta/wiki/Umbrella-Rust-Worker-Migration) not the Home page — so the cross-link survives Home reorgs.

NoETL Dashboard

Active Umbrellas

Closed Umbrellas

Conventions

Per-repo wikis

Clone this wiki locally