Skip to content

Commit 96f692b

Browse files
cdeustclaude
andcommitted
feat(wiki): expand guides catalogue to 27 canonical scopes
User feedback: "the guides should be covering a lot more, that's too shallow". The previous 18-scope set covered onboarding + installation + troubleshooting + contributing on the how-to axis, but most production projects need richer guide coverage. Adding nine more universal scopes: * ``configuration-reference`` — exhaustive table of every env var / config-key / CLI flag (reference companion to the task-oriented installation guide). * ``security`` — threat model, secret handling, isolation guarantees, hardening checklist. The page security review boards consult. * ``performance`` — measured throughput / latency / resource numbers with their benchmark sources; tuning knobs and capacity planning. Distinct from operations (recovery) — this is steady-state shaping. * ``migration`` — version-to-version upgrade paths, deprecations, rollback procedures, plus migration FROM competing tools. Distinct from CI/CD (our release process) — this is the user's upgrade experience. * ``debugging`` — the methodology of investigation: log levels, diagnostic commands, trace IDs, stack-trace reading. Distinct from troubleshooting (symptom → fix table). * ``testing`` — test layout, conventions, coverage targets, authoring workflow. Distinct from CI/CD (the pipeline that runs tests) — this is the developer's test-authoring path. * ``extending`` — extension points, plugin interfaces, customisation surface. For projects with no extension API, the page says so explicitly. * ``recipes`` — 8-20 worked-example walkthroughs ordered beginner → advanced, each copy-pasteable. * ``glossary`` — project-specific terms, acronyms, "what it is NOT" notes for common confusions. Total canonical scopes: 18 → 27. cortex coverage drops to 15/27 until the autonomous worker authors the new anchors; every project in the registry gets the same 9-anchor backlog appended. All wiki tests + ruff format + ruff check green. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent d2ff0bb commit 96f692b

1 file changed

Lines changed: 185 additions & 0 deletions

File tree

mcp_server/core/wiki_coverage.py

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,191 @@ class Scope:
408408
directories=("guides", "how-to"),
409409
suggested_kind="how-to",
410410
),
411+
Scope(
412+
name="configuration-reference",
413+
title="Configuration reference",
414+
description=(
415+
"Exhaustive table of every configurable knob: every "
416+
"environment variable, every config-file key, every CLI "
417+
"flag, every plugin setting. Columns: name | type | default "
418+
"| scope (process/session/global) | what it controls | "
419+
"valid values. Distinct from the installation guide (which "
420+
"is task-oriented step-by-step); this is the reference for "
421+
"people who already know what they're doing."
422+
),
423+
anchor_filenames=(
424+
"configuration-reference.md",
425+
"config-reference.md",
426+
"settings.md",
427+
"env-vars.md",
428+
),
429+
directories=("reference", "guides"),
430+
suggested_kind="reference",
431+
),
432+
Scope(
433+
name="security",
434+
title="Security model & hardening",
435+
description=(
436+
"The project's threat model + security posture. What "
437+
"secrets the project handles, how they're stored, what "
438+
"isolation guarantees exist, who can do what, the "
439+
"attack surface, mitigations in place, and the hardening "
440+
"checklist for production deployment. Sourced from "
441+
"security ADRs + audit findings. The page security review "
442+
"boards consult."
443+
),
444+
anchor_filenames=(
445+
"security.md",
446+
"SECURITY.md",
447+
"threat-model.md",
448+
"hardening.md",
449+
),
450+
directories=("guides", "reference"),
451+
suggested_kind="reference",
452+
),
453+
Scope(
454+
name="performance",
455+
title="Performance characteristics & tuning",
456+
description=(
457+
"Measured throughput / latency / resource consumption "
458+
"characteristics, with the benchmarks that produced them. "
459+
"Tuning knobs and when to turn each one. Capacity planning "
460+
"advice. Profiling instructions. Failure modes under load. "
461+
"Distinct from operations (which covers runbook recovery) — "
462+
"this covers expected steady-state behaviour and how to "
463+
"shape it."
464+
),
465+
anchor_filenames=(
466+
"performance.md",
467+
"benchmarks.md",
468+
"tuning.md",
469+
"scaling.md",
470+
),
471+
directories=("guides", "reference"),
472+
suggested_kind="reference",
473+
),
474+
Scope(
475+
name="migration",
476+
title="Migration & upgrade",
477+
description=(
478+
"Version-to-version upgrade paths: what changed, what's "
479+
"deprecated, what breaks, the script or command for each "
480+
"transition, rollback procedure. Plus migration FROM "
481+
"competing tools (if applicable) — the data-import or "
482+
"config-translation paths. Distinct from CI/CD release "
483+
"(which covers OUR release process); this is the USER's "
484+
"upgrade experience."
485+
),
486+
anchor_filenames=(
487+
"migration.md",
488+
"upgrade.md",
489+
"changelog.md",
490+
"CHANGELOG.md",
491+
),
492+
directories=("guides", "how-to"),
493+
suggested_kind="how-to",
494+
),
495+
Scope(
496+
name="debugging",
497+
title="Debugging guide",
498+
description=(
499+
"How to figure out what's happening at runtime: where logs "
500+
"go, log-level controls, the verbose / debug flags, the "
501+
"diagnostic commands, how to read a stack trace from this "
502+
"project's code, how to attach a debugger, the trace IDs "
503+
"/ correlation IDs and how to follow them. Distinct from "
504+
"troubleshooting (which is symptom → fix table) — this is "
505+
"the methodology of investigation."
506+
),
507+
anchor_filenames=(
508+
"debugging.md",
509+
"diagnostics.md",
510+
"logging.md",
511+
"observability.md",
512+
),
513+
directories=("guides", "how-to"),
514+
suggested_kind="how-to",
515+
),
516+
Scope(
517+
name="testing",
518+
title="Testing guide",
519+
description=(
520+
"How to write and run tests for this project: the test "
521+
"layout (unit / integration / e2e), conventions for "
522+
"fixtures + mocks + factories, coverage targets per layer, "
523+
"the test commands, how to debug a flaky test, how to add "
524+
"a new test category. Distinct from CI/CD (which covers "
525+
"the pipeline that runs tests) — this is the developer's "
526+
"test-authoring workflow."
527+
),
528+
anchor_filenames=(
529+
"testing.md",
530+
"tests.md",
531+
"test-strategy.md",
532+
"writing-tests.md",
533+
),
534+
directories=("guides", "how-to"),
535+
suggested_kind="how-to",
536+
),
537+
Scope(
538+
name="extending",
539+
title="Extending the project",
540+
description=(
541+
"Adding new features, plugins, custom strategies, or "
542+
"integrations. Where the extension points are, what the "
543+
"interfaces look like, the worked example of adding one. "
544+
'For projects with no extension surface, write "this '
545+
'project has no extension API" with one sentence on why '
546+
"and where to fork instead."
547+
),
548+
anchor_filenames=(
549+
"extending.md",
550+
"plugins.md",
551+
"customization.md",
552+
"extension-points.md",
553+
),
554+
directories=("guides", "how-to"),
555+
suggested_kind="how-to",
556+
),
557+
Scope(
558+
name="recipes",
559+
title="Recipes & cookbook",
560+
description=(
561+
'Common task walkthroughs — "how do I X?" answered with '
562+
"the exact commands and code. 8–20 short worked examples "
563+
"ordered from beginner to advanced, each one self-"
564+
"contained with copy-pasteable steps + expected output. "
565+
"The page users land on when they ask the project a "
566+
"concrete question."
567+
),
568+
anchor_filenames=(
569+
"recipes.md",
570+
"cookbook.md",
571+
"examples.md",
572+
"patterns.md",
573+
),
574+
directories=("guides", "how-to"),
575+
suggested_kind="how-to",
576+
),
577+
Scope(
578+
name="glossary",
579+
title="Glossary",
580+
description=(
581+
"Every project-specific term + acronym defined in one "
582+
"place. Sorted alphabetically. Each entry: term | "
583+
"definition | where in the codebase to see it used | "
584+
"what it is NOT (when there's a common confusion). The "
585+
"page a non-technical reader and a new engineer both "
586+
"consult first."
587+
),
588+
anchor_filenames=(
589+
"glossary.md",
590+
"terminology.md",
591+
"definitions.md",
592+
),
593+
directories=("reference", "guides"),
594+
suggested_kind="reference",
595+
),
411596
)
412597

413598

0 commit comments

Comments
 (0)