Edit and review documentation pages

Open a page in a Space you can edit to maintain its content directly. Manual editing is useful for corrections, context and instructions that should not require a full regeneration.

Make an effective edit

Start with the reader's goal. Explain prerequisites before steps, include a concrete example where it helps, and state the expected outcome. Use headings to separate tasks rather than creating a long uninterrupted page.

Use the editor's controls for paragraphs, lists, links, code blocks, tables and supported rich blocks. Choose a language for code examples and remove real credentials from anything readers might copy.

Review saved content

After editing, confirm the content is saved and reopen the page. Check tables, code formatting and links in the reading view, not only the editor. When using AI editing, review the changed passage and its surrounding context before treating the revision as final.

For endpoint documentation, use API blocks where their structured presentation helps. For a whole new topic based on repository source, Update Documentation Gaps can prepare a proposal.

Understand permissions

Viewing a Space does not imply permission to edit it. If editing controls are unavailable, check your team role and Space access with the owner.

For generation-backed pages, also understand the generation version being used. Do not assume every manual edit is automatically a complete snapshot of the Space's previous structure.