Module guide 

Content of the guide tool: per block type from the CMS schema export, per topic hand-written.

Enums

GuideTopic

Constants

CITATIONS_AND_GLOSSARY 🔒

COURSE_STRUCTURE 🔒

EDITING 🔒

EXERCISES 🔒

PREVIEWS_AND_CHECKS 🔒

PUBLISHING_AND_RISK 🔒

RICH_TEXT 🔒

Functions

answer

The guide tool’s result: the guide of each block type and topic asked for, or with neither asked for, the index of both. schemas may be None only when only topics are asked for.

block_guide 🔒

blocks_guide 🔒

Each block type’s schema, nesting rules and an example add op, with the rich-text formats. Errors on an unknown block type, listing similar ones.

index 🔒

What the guide covers: its topics and the block types each page type allows.

topics_guide 🔒

The hand-written guide of each topic.