61 lines
2.5 KiB
Markdown
61 lines
2.5 KiB
Markdown
# SCHEMA — devops-lib wiki
|
|
|
|
<!-- m-wiki: schema base-sha=5399a5ddc36b generated-at=2026-05-21 -->
|
|
|
|
LLM-maintained wiki for the **devops-lib** Jenkins shared library, generated by `/m-wiki:wiki-init` (bootstrap mode).
|
|
|
|
## Layout
|
|
|
|
```
|
|
docs/wiki/
|
|
├── SCHEMA.md ← this file (schema, layout, conventions)
|
|
├── index.md ← table of contents (auto-regenerated)
|
|
├── log.md ← per-run sync log
|
|
├── MANIFEST.md ← run statistics + page counts
|
|
├── allowlist.yaml ← qmd index allowlist (scaffolded, hand-editable)
|
|
├── .citation-index.json ← symbol-to-page mapping (auto-regenerated; v0.6+)
|
|
├── .drift-queue/ ← staged drift signals (committed, drained by next wiki-init)
|
|
└── pages/
|
|
├── 01-overview.md
|
|
├── 02-entry-points.md
|
|
├── 03-build-dispatch.md
|
|
├── 04-deploy-flow.md
|
|
├── 05-cross-cutting.md
|
|
└── concepts/
|
|
├── whitelists.md
|
|
├── secrets-and-auth.md
|
|
└── observability.md
|
|
```
|
|
|
|
## Page types
|
|
|
|
| Type | Path | Soft cap |
|
|
|---|---|---|
|
|
| `top-level` | `pages/NN-NAME.md` | narrative; no hard limit |
|
|
| `concept` | `pages/concepts/<slug>.md` | ≤600 words; lint warns >1500 |
|
|
|
|
## Provenance line
|
|
|
|
Every page starts with the provenance comment + a human-readable Generated line. The skill validates these on every re-run.
|
|
|
|
```
|
|
<!-- m-wiki: type=top-level slug=overview topic=null base-sha=5399a5ddc36b generated-at=2026-05-21 sources=[code:vars/buildPipeline.groovy, code:src/com/meesho/stages/buildObjHelper.groovy] -->
|
|
|
|
> Generated 2026-05-21 at base-sha 5399a5ddc36b. Type: top-level. 2 sources.
|
|
```
|
|
|
|
## Settings
|
|
|
|
- `max-hierarchy-depth: 1` — single-service repo, no monorepo subpaths.
|
|
- `mode: bootstrap` (this run). Subsequent runs flip to `update` once `SCHEMA.md` exists.
|
|
- `qmd-collection: devops-lib-wiki`.
|
|
|
|
## Boundary rules
|
|
|
|
- m-wiki **writes** only inside `docs/wiki/`.
|
|
- m-wiki **indexes** the files declared in `allowlist.yaml` (`mode: index`) and **folds** the bodies of files declared `mode: synthesize` into concept pages (on the next update run — bootstrap defers synthesis).
|
|
- `raw/` is the team's input layer; humans drop curated source docs there. None exist for this repo yet.
|
|
- `.pre-commit-config.yaml` is gitignored (per-dev); teammates must run `/m-wiki:wiki-setup` on their own clones to get drift hooks.
|
|
|
|
See `/Users/roshan.v/.claude/plugins/marketplaces/meesho-skills/m-wiki/references/doctrine.md` for the full doctrine.
|