Help and Support

FAQ and glossary

Answers about automation, review, roles, and publishing, followed by Pageloop terms.

FAQ and glossary

FAQ

What does Pageloop do on its own, and what do I still need to do?

Pageloop reads the sources you connect, compares them with your documentation, and drafts changes from your requests or active workflows. You set the scope and instructions, answer questions when Pageloop needs a decision, and review the result; Pageloop does not treat a draft as permission to publish.

What can each role do?

Admins can start runs, review all Inbox items, edit and publish documentation, and manage workspace settings, integrations, and member roles. Editors can start runs, use Ask and Workflows, review all items, edit and publish documentation, manage Style and Templates, and invite Editors or Contributors, but cannot manage Admin-only settings or change member roles. Contributors review and edit only their assigned Inbox items, read the Knowledge Base, and hand work to an Admin or Editor with Ready for Publish rather than publishing or starting runs.

How long does a docs run take?

There is no fixed completion time: a run must read its sources, compare the documentation, draft changes, and check the result. You can leave the page and return to the Inbox; if the run is waiting for answers, it needs your input before it can continue.

Where do drafts go?

Proposed documentation changes go to the Inbox, where you open an item to review its changes. A run can also update an existing item's proposal or finish with no changes needed, so not every run creates a separate draft.

Why does an item show Needs input?

Needs input means Pageloop is waiting for answers rather than continuing to draft; the Inbox also labels this state Needs answers. Open the item, answer the questions, and submit your answers so Pageloop can continue with those decisions.

Does Pageloop ever publish without approval?

No—generating a draft is not approval to publish, and Contributors must hand their work to an Admin or Editor. An Admin or Editor can authorize publication for later with a publishing schedule, so an approved publication can happen without another click at the scheduled time; a scheduled repository merge still waits for approval.

How do workflows differ from publishing schedules?

Workflows define when Pageloop starts a job and what steps it follows, such as checking merged code and drafting documentation updates. A publishing schedule sets when reviewed changes go live, or when an approved documentation pull request merges; scheduling a workflow run does not schedule publication.

Glossary

TermDefinitionWhere it appears
AdminAn Admin is a workspace member who can manage workspace settings and access as well as write, review, and publish documentation.Role labels in Settings → Members and workspace details in Settings.
AskAsk is the conversation with Pageloop where you ask questions or request documentation work.The main sidebar and Ask buttons beside your work, for Admins and Editors.
Automated screenshotsAutomated screenshots configures how Pageloop signs in to your product and what it may capture for documentation.Settings → Capture → Automated screenshots, for Admins in workspaces where the section is available.
changeA change is one proposed edit to documentation, such as revised text, an image replacement, or a navigation update.An Inbox item's Changes tab.
change cardA change card presents a proposed edit with its context and review controls.The review area of an Inbox item's Changes tab.
change setA change set groups proposed documentation edits so you can review and deliver them together.Inbox review and the Knowledge Base's draft workspaces.
ConnectionsConnections lists agents you have authorized to act in your workspace, including what each may do and where.The Connections page in Settings, reached from the agent consent screen rather than the Settings menu.
ContributorA Contributor is a workspace member who reviews assigned Inbox items and hands them back for publication.Role labels in Settings → Members and workspace details in Settings.
docs runA docs run is one execution of Pageloop's documentation work, which can produce proposed changes, ask questions, or find that no edits are needed.Run activity in Home and Inbox, and the Runs tab of a workflow.
EditorAn Editor is a workspace member who can write, review, and publish documentation without managing Admin-only workspace settings.Role labels in Settings → Members and workspace details in Settings.
Fix with PageloopFix with Pageloop requests a proposed correction for problems found by a documentation pull request check.Pageloop's check or comment on a repository pull request or merge request, leading to a Start fix page.
Help center designHelp center design controls your documentation site's appearance and site configuration, including colors, branding, typography, and navigation bar.Opened from Knowledge Base, with its own section navigation, for Admins of Pageloop-hosted sites.
HomeHome summarizes your review queue, activity, connected integrations, and work that needs attention.Home in the main sidebar.
InboxInbox is the queue where you review proposed documentation changes and answer questions about the work.Inbox in the main sidebar.
itemAn item is an entry in the Inbox that brings together a piece of documentation work, its activity, and any proposed changes or questions.Inbox rows and the detail page you open from a row.
Knowledge BaseKnowledge Base is where you browse, search, and organize your documentation pages and folders.Knowledge Base in the main sidebar.
MembersMembers is where Admins and Editors invite teammates and view their workspace roles and membership status.Settings → Workspace → Members.
pull request checksPull request checks validate proposed repository documentation changes and report publishing blockers and warnings.Settings → Knowledge base → Source → Pull request checks, when available, with results on repository pull requests or merge requests.
question round (Needs input)A question round is a set of questions Pageloop asks you to resolve decisions before continuing its work.An Inbox item's question panel and Ask conversations, with waiting items also labeled Needs answers.
Ready for PublishReady for Publish hands an assigned item from a Contributor to an active Admin or Editor with the Contributor's edits, decisions, and optional note.The handoff action and recipient dialog on a Contributor's Inbox item.
StyleStyle supplies product context, writing preferences, terms to preserve, and screenshot annotation colors for Pageloop's drafts.Settings → Writing → Style, for Admins and Editors, with the color palette limited to Admins.
TemplatesTemplates are collections of example articles that guide the structure of new drafts.Settings → Writing → Templates, for Admins and Editors.
WorkflowsWorkflows are saved automations that pair a trigger with plain-language steps for Pageloop to carry out.Workflows in the main sidebar and Settings → Workspace → Workflows, for Admins and Editors.

For navigation details, see The Pageloop sidebar.