docs-page

To write MyST documentation pages that pass repository checks, enforce frontmatter, headers, TOC membership, and link safety rules. Validate page layout, kernel metadata, and executable cells to ensure reliable docs publishing without breaking the test suite or site navigation.

The best way to create executable tutorial notebooks with hidden validation cells is to author them under docs/notebooks/ using MyST structure. Include executable cells with hidden assertions to demonstrate library workflows and enforce page-specific constraints for testing.

Validate frontmatter and TOC membership for MyST markdown pages by running a documentation checker that enforces page layout, kernel metadata, DOI freezing, and link safety rules. This ensures pages follow strict repository-specific constraints before finishing edits and publishing.

Your xmris documentation page breaks the docs build or test suite when it violates MyST structure, frontmatter, TOC membership, or link safety rules. Incorrect kernel metadata, invalid executable cells, or missing DOI freezing constraints also cause build failures during repository checks.

Yes, you can use Jupytext to write explainer pages with live code cells under docs/explanation/. These conceptual pages answer why the library is designed a certain way and support executable cells while enforcing MyST structure and page-specific constraints for reliable rendering.

Yes, contributor guide pages under docs/contributing/ require specific genre templates to ensure correct page structure. Produce procedural documentation with clear step-by-step instructions, enforcing MyST rules, frontmatter, and TOC membership for reliable docs publishing and site navigation.