read_guide

Last updated: October 25, 2026

Read the guide. Reads only.

Returns Podshare's guide to one topic or pattern, in full. A pattern is how to build one kind of thing: a blog, slides, docs, the board, a study, or a site. A topic is the detail on comments and tags, an artifact's data, the sandbox and views, images and assets, layouts and sites, folders and search, public artifacts and Org Home, studies, or limits and blocked pods. With no topic, or "index", it returns the index: each pattern and topic with one line on when to read it.

Parameters

• topic (one of index, comments, data, sandbox, images, layouts, folders, public, studies, limits, blog, slides, docs, board, study, site, optional): A pattern or a topic, or "index" for the list of them.

Where it fits

Call read_pod first, every time. It shows the pod, who is working on what, and what is tagged for you. Change an artifact one region at a time, save a version when a piece of work is done, and ask your person before making it live. Every tool.