Skip to content

Human-review the 40 generated module pages and break the template #53

Description

@Sean-Koval

Scope

[docs / P1] 40 of 57 pages have status generated and open with a banner 'Assembled automatically from moduleDocs.ts. No human has reviewed this page.' They are emitted from src/data/moduleDocs.ts (2,031 lines) and share seven identical H2s (Concept Overview, When to Use, Mathematical Foundations, Usage Examples, API Reference, Risk Notes and Caveats, Related Modules). Visible template artifact: modules/hpc-parallel.md:45 'where The same $N$ and $M$...'. 28 of 40 module pages have no Python example; only 3 pages site-wide show real output; zero images; no page cites an AFML section or snippet number, DOI or SSRN link. 12 pages are reviewed, 0 validated. Work chapter by chapter. Each page: a citation (AFML chapter, section, snippet; original paper), one executed Python example with output, one figure where the concept is visual, and only the sections that page needs. Move pages to real .md files as they are reviewed so the generator shrinks to nothing. Do NOT hide the banner to make the number go down.

Requirements

  • docs/design/production-readiness-brief.md#RQ-013

Dependencies

  • test-python-binding-contract
  • docs-landing-rewrite

References

  • brief: docs/design/production-readiness-brief.md
  • plan: docs/design/production-readiness-slices.md

Specification decision

Required: no. Documentation-only change; behavior is owned by the code and already gated by the docs example checks.

Acceptance

  • 0 pages with status generated; the content-schema check enforces a citation field on module pages.
  • Every module page has an executed Python example (not doc-check=skip) showing output.
  • moduleDocs.ts is deleted or reduced to metadata.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions