Migrate and Refactor Documentation
Last modified by Eleni Cojocariu on 2026/03/07 21:17
As of September 2025, documentation is being refactored, and moved to /documentation root. These steps describe the flow of how to migrate or reorganize existing documentation content from older locations ("Documentation" or Extensions wiki) into the /documentation root. Following them helps avoid duplicated work, content and ensures consistent structure and navigation.
- Check for existing Change Requests. Before starting any migration work, make sure that no one else is already working on the same page or content.
- Use the documentation resources section. It provides XAR files that you can import into your wiki to quickly set up a realistic environment, with ready-made examples for creating screenshots and documentation content.
- Choose the Right Location. Decide where the migrated content should live inside the documentation tree.
- Apply Diataxis. When migrating existing documentation, you may encounter pages or sections that mix multiple documentation types. Such content must be split into multiple pages, each with a single purpose and corresponding to a Diataxis type.
- Create pages using the correct page structure.
- Respect the versioning rules, the documentation style guidelines, the attachment rules.
- Save the changes.
- (Optional) Add Highlights. When applicable, add highlights to help readers quickly discover key pages or concepts.
- Improve navigation by pinning pages in the navigation panel. Where it makes sense, pin the migrated pages in the navigation to improve discoverability.
- Avoid duplication. Make sure the same content is not kept in both the original documentation and the new documentation pages. When content has been moved, properly handle the original documentation pages.
- If you are creating new documentation, follow the Create New Documentation- Flow Guide.
- To update existing documentation pages, follow the process described in updating existing pages.